Get document translation job info

Get information about a document translation job.

This endpoint can be used to poll for the status of a document translation job. The jobId is obtained from a successful call to the /v2/documents/translate endpoint.

The response contains information about the job, including its status. The possible statuses are:

• CREATED: The translation job is in the queue.
• IN_PROGRESS: The translation is being processed.
• SUCCESS: The translation was successful.
• FAILED: The translation failed.

If the status is SUCCESS, the translated document can be downloaded using the /v2/documents/{jobId}/download endpoint.

If the status is FAILED, the reason, errorCode and errorData fields in the response will contain details about the failure.

Caution

• The information and document is only available for 1 hour, after that it is deleted.
• In case you don't download the translated document within that time, you will need to send another translation request.

Path Parameters
jobId uuid — REQUIRED

Responses
200 Successful response Schema — OPTIONAL jobId uuid The ID of the document translation job. source BCP-47 Possible values: 2 ≤ length ≤ 25 The source language of the translation. target BCP-47 Possible values: 2 ≤ length ≤ 25 The target language of the translation. successCallbackUrl Success callback URL The URL that will be called upon successful translation. Will be null if not provided when the translation was started. errorCallbackUrl Error callback URL The URL that will be called if the translation fails. Will be null if not provided when the translation was started. translationId Translation ID The custom ID provided when the translation was started. Will be null if not provided when the translation was started. status Document translation status Possible values: [CREATED, IN_PROGRESS, SUCCESS, FAILED] Enum for describing the state of a document translation job. reason Reason A human-readable reason for the failure, if the job failed. Will be null otherwise. errorCode Error code A machine-readable error code, if the job failed. Will be null otherwise. Possible values are described in the DocumentTranslationErrorCode enum. More values may be added in the future, so we recommend using a flexible schema (e.g. a string) for this field. errorData Additional data about the error, if the job failed. Will be null otherwise.
401 The access token provided is missing, expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the protected resource request. Schema — OPTIONAL detail Detail A generic JSON value, typically a string describing the error.
403 The request requires higher privileges than provided by the access token. The request should not be retried. Schema — OPTIONAL detail Detail A generic JSON value, typically a string describing the error.
404 Document translation not found Schema — OPTIONAL detail Detail The provided job ID does not exist
422 Validation Error Schema — OPTIONAL detail object[] — OPTIONAL loc undefined[] msg Message type Error Type
429 Too many requests in the time interval Schema — OPTIONAL detail Detail A generic JSON value, typically a string describing the error.
500 Internal server error Schema — OPTIONAL detail Detail A generic JSON value, typically a string describing the error.