Export Status

View as Markdown
Poll async export status and retrieve a signed `download_url` when `export_state` is `Completed`. Provide either `export_id` (from the trigger response) or `lang` (returns the latest export for that language). > Signed download URLs are time-limited (~24h). Re-fetch this endpoint for a fresh URL rather than caching long-term.

Authentication

api-subscription-keystring
API Key authentication via header

Path parameters

job_idstringRequired

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

Query parameters

langenumOptional

BCP-47 target language code — returns the latest export for this language. Required: at least one of lang or export_id must be provided.

export_idstringOptional

Specific export job id returned by POST /translate/document/jobs/{job_id}/export. Required: at least one of export_id or lang must be provided.

Response

Export status.
export_idstring
Unique export job identifier.
job_idstring
The job this export belongs to.
target_language_codestring

BCP-47 code of the exported file.

formatstring

Output format (e.g. pdf, docx, xlsx).

export_stateenum

Current state of the export: Pending, Running, Completed, or Failed.

created_atstringformat: "date-time"
Export creation timestamp.
download_urlstring or nullOptional

Signed download URL when export_state is Completed.

filenamestring or nullOptional
Output filename.
file_sizeinteger or nullOptional
Output file size in bytes.
expires_in_hoursinteger or nullOptional
Hours until the download URL expires.
error_messagestring or nullOptional

Sanitized failure reason when export_state is Failed.

completed_atstring or nullOptionalformat: "date-time"

Export completion timestamp. Present when export_state is Completed or Failed.

progressinteger or nullOptional

0–100 for PDF/DOCX page render; omitted for other formats.

pages_completedinteger or nullOptional

Pages rendered so far (PDF/DOCX with page-level render).

pages_totalinteger or nullOptional
Total pages in the export render pass.

Errors

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