Status (Check the document translation status)
- Print
- PDF
Status (Check the document translation status)
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
- API for checking translation progress of document file (GET)
- Returns current processing stage and progress (%)
Header
Name | Description |
---|---|
X-NCP-APIGW-API-KEY-ID | Client ID issued during NCP app registration |
X-NCP-APIGW-API-KEY | Secret Key issued during NCP app registration |
Parameter
Name | Type | Required | Description |
---|---|---|---|
requestId | String | true | Request ID issued during Translate API request |
Response
Returned in the json format
Field Name | Type | Description |
---|---|---|
data | JSON Object | |
data.status | String | Current stage of translation - WAITING: waiting for translation - PROGRESS: translation in progress - COMPLETE: translation completed (downloadable) - FAILED: file translation failed |
data.progressPercent | Integer | Translation progress of the file (%) |
data.errCode | String | Error code. Provided if the status is FAILED |
data.errMsg | String | Error message. Provided if the status is FAILED |
Example
If translation is completed
{
"data": {
"status": "COMPLETE"
}
}
If translation failed
{
"data": {
"status": "FAILED",
"errCode": "01",
"errMsg": "Error upload file to server"
}
}
Error Code | Error Message | Description |
---|---|---|
01 | Error upload file to server | File upload failed |
10 | Translated Doc is empty | Translated document has no text but only empty pages |
11 | Translated Docs length exceeded max-len | Character limit exceeded (300,000) |
15 | Parsing is not possible | Parsing library failed (file unable to be translated) |
16 | Unsupported source language | Source language unsupported |
17 | Detected langcode is the same as target langcode | Detected source and target languages are the same |
18 | Language detection failed | Language undetected |
50 | internal parser error | Internal parser error |
60 | internal server error | Internal server error |
Error codes
{
"error": {
"errorCode": "25003",
"message": "requestId is invalid"
}
}
HTTP Status Code | Code | Message | Description |
---|---|---|---|
401 | 25003 | requestId is invalid | Request has been made with an invalid request ID |
404 | 25006 | Not Found | Document has no translated copy |
CURL Example
$ curl -X GET 'https://naveropenapi.apigw.ntruss.com/doc-trans/v1/status?requestId=20201007_2522985202669'
{"data":{"status":"COMPLETE"}}
Was this article helpful?