Status (Check the document translation status)
    • PDF

    Status (Check the document translation status)

    • PDF

    Article Summary

    Overview

    • API for checking translation progress of document file (GET)
    • Returns current processing stage and progress (%)

    Header

    NameDescription
    X-NCP-APIGW-API-KEY-IDClient ID issued during NCP app registration
    X-NCP-APIGW-API-KEYSecret Key issued during NCP app registration

    Parameter

    NameTypeRequiredDescription
    requestIdStringtrueRequest ID issued during Translate API request

    Response

    Returned in the json format

    Field NameTypeDescription
    dataJSON Object
    data.statusStringCurrent stage of translation
    - WAITING: waiting for translation
    - PROGRESS: translation in progress
    - COMPLETE: translation completed (downloadable)
    - FAILED: file translation failed
    data.progressPercentIntegerTranslation progress of the file (%)
    data.errCodeStringError code. Provided if the status is FAILED
    data.errMsgStringError 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 CodeError MessageDescription
    01Error upload file to serverFile upload failed
    10Translated Doc is emptyTranslated document has no text but only empty pages
    11Translated Docs length exceeded max-lenCharacter limit exceeded (300,000)
    15Parsing is not possibleParsing library failed (file unable to be translated)
    16Unsupported source languageSource language unsupported
    17Detected langcode is the same as target langcodeDetected source and target languages are the same
    18Language detection failedLanguage undetected
    50internal parser errorInternal parser error
    60internal server errorInternal server error

    Error codes

    {
      "error": {
        "errorCode": "25003",
        "message": "requestId is invalid"
      }
    }
    
    HTTP Status CodeCodeMessageDescription
    40125003requestId is invalidRequest has been made with an invalid request ID
    40425006Not FoundDocument 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?

    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.