Get translation status

The Get translation status method returns the status for a document translation request. The status includes the overall request status and the status for documents that are being translated as part of that request.

Request URL

Send a GET request to:

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/batches/{id}

Learn how to find your custom domain name.

Important

  • All API requests to the Document Translation service require a custom domain endpoint.
  • You can't use the endpoint found on your Azure portal resource Keys and Endpoint page nor the global translator endpoint—api.cognitive.microsofttranslator.com—to make HTTP requests to Document Translation.

Request parameters

Request parameters passed on the query string are:

Query parameter Required Description
id True The operation ID.

Request headers

Request headers are:

Headers Description
Ocp-Apim-Subscription-Key Required request header

Response status codes

The following are the possible HTTP status codes that a request returns.

Status Code Description
200 OK. Successful request and returns the status of the batch translation operation. HeadersRetry-After: integerETag: string
401 Unauthorized. Check your credentials.
404 Resource is not found.
500 Internal Server Error.
Other Status Codes
  • Too many requests
  • Server temporary unavailable

Get translation status response

Successful get translation status response

The following information is returned in a successful response.

Name Type Description
id string ID of the operation.
createdDateTimeUtc string Operation created date time.
lastActionDateTimeUtc string Date time in which the operation's status has been updated.
status String List of possible statuses for job or document:
  • Canceled
  • Cancelling
  • Failed
  • NotStarted
  • Running
  • Succeeded
  • ValidationFailed
summary StatusSummary Summary containing the details listed below.
summary.total integer Total count.
summary.failed integer Failed count.
summary.success integer Number of successful.
summary.inProgress integer Number of in progress.
summary.notYetStarted integer Count of not yet started.
summary.cancelled integer Number of canceled.
summary.totalCharacterCharged integer Total characters charged by the API.

Error response

Name Type Description
code string Enums containing high-level error codes. Possible values:
  • InternalServerError
  • InvalidArgument
  • InvalidRequest
  • RequestRateTooHigh
  • ResourceNotFound
  • ServiceUnavailable
  • Unauthorized
message string Gets high-level error message.
target string Gets the source of the error. For example, it would be "documents" or "document id" for an invalid document.
innerError InnerTranslationError New Inner Error format which conforms to Cognitive Services API Guidelines. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
innerError.code string Gets code error string.
innerError.message string Gets high-level error message.
innerError.target string Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document.

Examples

Example successful response

The following JSON object is an example of a successful response.

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

Example error response

The following JSON object is an example of an error response. The schema for other error codes is the same.

Status code: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

Next steps

Follow our quickstart to learn more about using Document Translation and the client library.