Skip to main content
POST
document.translate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
fileId
string
required

Id of an uploaded file holding a document to translate, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
filename
string
required

Original document name and extension.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9][A-Za-z0-9._ -]*\.(txt|html|htm|xlf|xliff|srt|pdf|docx|pptx|xlsx)$
targetLanguage
string
required

Target language.

Maximum string length: 24
sourceLanguage
string

Source language; omit for detection where supported.

Maximum string length: 24
formality
enum<string>
default:default

Requested tone; default default.

Available options:
default,
more,
less
outputFormat
enum<string>

Output file extension; omit to retain the input format.

Available options:
txt,
html,
xlf,
xliff,
srt,
pdf,
docx,
pptx,
xlsx

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.