Skip to navigation
APIsDocument Translation

Start Job

View as Markdown

Start the translation pipeline after the file has been uploaded to the signed upload_url. Idempotent.

Authentication

api-subscription-keystring
API Key authentication via header

Path parameters

job_idstringRequired

The job_id returned by POST /translate/document/jobs.

Response

Job started.
job_idstring
job_stateenum

Aggregate job state returned by GET /jobs/{job_id}/live-status.

Allowed values:
num_pagesintegerOptional

Number of pages in the source document. Present for PDF jobs; omitted for Office formats.

warningslist of stringsOptional

Server warnings (e.g. filename overridden from content detection). Omitted when empty.

num_chunksintegerOptional

Number of translation chunks the source file was split into. Present for Markdown / plain-text jobs; omitted for other formats.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
500
Internal Server Error