Skip to main content
PATCH
Re-sending the same glossary id applies its latest version. It never retranslates: call retranslateSegments to apply the settings to existing segments. When to use: to change how future translations are made. Side effects: Future translations use the new settings; existing translations are unchanged. Cost: Free. Idempotency: Idempotency-Key accepted (SDKs send one); retries within 24 h replay the first response. Concurrency: If-Match with the translation settings ETag is optional; a stale value fails with 412. Plan: non-empty translation_instructions -> translation_instructions; non-empty glossary_id -> glossary. Required scopes: transcripts:write Errors: glossary_not_found (404), glossary_language_mismatch (422), feature_not_in_plan (403)

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

transcripts:write

Headers

Idempotency-Key
string

Optional. A unique key per logical request (SDKs send a bare UUIDv4; an RFC 9651 quoted string is accepted and unquoted); reuse it unchanged on retries to replay the first response.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$
If-Match
string

Optional translation-settings ETag; a stale value fails with 412.

Maximum string length: 128

Path Parameters

project_id
string
required

Project id (from createProject or listProjects).

Maximum string length: 64

Body

application/json

Changes apply to future translations only: call retranslateSegments to apply them.

translation_instructions
string

Instructions (entitlement translation_instructions); an empty string clears them.

Maximum string length: 8192
glossary_id
string

Glossary (entitlement glossary; matching languages); an empty string detaches. Re-sending the same id applies its latest version.

Maximum string length: 64

Response

OK: TranslationSettings.

A project's translation settings. Changing them never retranslates: call retranslateSegments.

object
enum<string>
required

Always translation_settings.

Available options:
translation_settings
id
string
required

The project id.

translation_instructions
string | null
required

Instructions for the translator (<= 8192).

glossary
object | null
required

Attached glossary.

etag
string
required

ETag.