Check document translation status
    • PDF

    Check document translation status

    • PDF

    Article summary

    Available in Classic and VPC

    Check the progress of a document translation with the current processing stage and progress (%).

    Request

    This section describes the request format. The method and URI are as follows:

    MethodURI
    GET/status

    Request headers

    For information about the headers common to all Papago Translation APIs, see Common Papago Translation headers.

    Request query parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    requestIdStringRequiredID issued with the translation request (Request ID)
    • Unique identification value for each document translation request

    Request example

    The request example is as follows:

    curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/doc-trans/v1/status
    ?requestId={requestId}' \
    --header 'X-NCP-APIGW-API-KEY-ID: {Client ID issued when registering the app}' \
    --header 'X-NCP-APIGW-API-KEY: {Client secret issued when registering the app}'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    dataObject-Progress details
    data.statusString-Current translation progress stage
    • WAITING | PROGRESS | COMPLETE | FAILED
      • WAITING: translation pending
      • PROGRESS: translation in progress
      • COMPLETE: translation complete and file available for download
      • FAILED: translation failed
    data.progressPercentInteger-File translation progress (%)
    • Can be checked if status is PROGRESS
    data.errCodeString-Error code
    • Can be checked if status is FAILED
    data.errMsgString-Error message
    • Can be checked if status is FAILED

    Response status codes

    For information about the HTTP status codes common to all Papago Translation APIs, see Common Papago Translation response status codes.

    Response example

    The response example is as follows:

    Success

    The following is a sample response upon a successful call.

    {
        "data": {
            "status": "COMPLETE"
        }
    }
    
    {
        "data": {
            "status": "PROGRESS",
            "progressPercent": 24
        }
    }
    

    Failure

    The following is a sample response upon a failed call.

    {
        "data": {
            "status": "FAILED",
            "errCode": "17",
            "errMsg": "Detected langcode is the same as target langcode"
        }
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.