Skip to main content
POST
Translate with AI (write)

Authorizations

Authorization
string
header
required

API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's granted RBAC permissions determine access; see each operation's x-permission.

Path Parameters

projectId
string
required

Project id (UUID) or id-embedded path slug.

Query Parameters

branch
string

Target an open translation branch instead of main. Required when the project's main branch is protected.

Body

application/json
targetLanguageCodes
string[]
required

Target BCP-47 language codes to translate into.

Minimum array length: 1
Minimum string length: 2
Example:
keyIds
string[]

Restrict to these key ids. Omit to consider every key in the project.

onlyEmpty
boolean

Translate only keys with no existing value in the target language.

onlyOutdated
boolean

Include values flagged outdated (the source changed after the value was last set).

includeTags
string[]

Only keys carrying at least one of these tags.

excludeTags
string[]

Skip keys carrying any of these tags.

keyPrefix
string

Only keys whose id starts with this prefix, e.g. home..

autoApprove
boolean

Approvers only: apply directly instead of proposing when the project requires approval. Ignored for callers without approval rights (the write still lands as a proposal).

review
boolean

Run the engine's review pass on this run. Omit to follow the engine default.

batch
boolean

Use the provider's asynchronous batch path (~50% cheaper, higher latency).

Response

The queued job's id and initial status.

success
boolean
required
data
object
required