Translate document

Prev Next

Available in Classic and VPC

Translate and output a document file. It issues a request ID on a successful call, and the issued ID is used to Check document translation status and Download document translation result.

Note

Please note the following before use:

  • Text with images cannot be translated.
  • Some styles applied to text may not match or may be omitted.
  • Some links or actions applied to the text may not work or may be omitted.
  • Password protected files not supported.
  • Read-only files are not supported.
  • Up to 10 APIs can be called simultaneously, including documents in the translation process.

Notes for each supported document

Doc Translation supports translation of Microsoft Office documents, PDF documents, and Hangul documents. When using the API, check the notes for each supported document.

Document type Remarks
Microsoft Office document
  • Supported formats: .docx, .pptx, .xlsx
PDF document
  • Supported format: .pdf
  • We recommend using documents with as few visual elements as possible, as layout, paragraph spacing, design formatting, custom fonts, and image sizes can affect translation quality.
  • We recommend using native PDF files for best results.
  • When translating scanned documents, the quality of the scan may affect the translation quality and documents should be scanned in the same orientation as the original document.
  • The size of the translated file may be larger than the original document.
  • Document layout and style preservation results are better for DOCX and PPTX files than for PDF files, so consider this when translating.
  • Documents containing more than one language may have different translation results depending on the starting (source) language setting.
Hangul document
  • Supported format: .hwp
  • Support for HWP 5.0 or later versions used since Hancom Office 2002.
  • Distribution files are not supported.
  • HWP files not created in Hancom Office are not supported. Example: Files with only the extension changed
  • Text overlap may occur if the sentence becomes longer after translation, and can be viewed normally by increasing the text area.
  • Developed in accordance with HWP public documentation by Hancom

Request

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

Method URI
POST /translate

Request headers

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

Request body

You can include the following data in the body of your request:

Field Type Required Description
source String Required Language code of the source text
  • auto (automatic language detection) | ko (Korean) | en (English) | ja (Japanese)| zh-CN (Chinese (Simplified)) | zh-TW (Chinese (Traditional)) | vi (Vietnamese) | th (Thai) | id (Indonesian) | fr (French) | es (Spanish) | ru (Russian)
  • For information about language pairs for which translation is supported, see Languages supported for translation.
target String Required Language code of the target text
  • ko (Korean) | en (English) | ja (Japanese)| zh-CN (Chinese (Simplified)) | zh-TW (Chinese (Traditional)) | vi (Vietnamese) | th (Thai) | id (Indonesian) | fr (French) | es (Spanish) | ru (Russian)
  • For information about language pairs for which translation is supported, see Languages supported for translation.
file File Required Document file to translate
  • Up to 100 MB, less than 300,000 characters
  • Supported file formats: .docx | .pptx | .xlsx | .pdf | .hwp
    • .docx: Word file
    • .pptx: PowerPoint file
    • .xlsx: Excel file
    • .pdf: PDF file
    • .hwp: Hangul file
glossaryKey String Optional Glossary ID
  • Customized translation is applied based on the glossary data.
  • Korean ⇔ English, Korean ⇔ Japanese, Korean ⇔ Chinese (Simplified), Korean ⇔ Chinese (Traditional), Korean ⇔ French, English ⇔ Japanese, English ⇔ Chinese (Simplified), English ⇔ Chinese (Traditional), English ⇔ Vietnamese, English ⇔ Thai, English ⇔ Indonesian, English ⇔ French, Japanese ⇔ Chinese (Simplified), Japanese ⇔ Chinese (Traditional)

Languages supported for translation

The following describes the supported languages for translation.

Supported language Translation direction Supported language
Korean ⇔ English, Japanese, Chinese (Simplified), Chinese (Traditional), Vietnamese, Thai, Indonesian, French, Spanish, Russian
English ⇔ Korean, Japanese, Vietnamese, Thai, Indonesian, French
Japanese ⇔ Korean, English
Chinese (simplified) ⇔ Korean
Chinese (traditional) ⇔ Korean

Request example

The request example is as follows:

curl --location --request POST 'https://papago.apigw.ntruss.com/doc-trans/v1/translate' \
--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}' \
--header 'Content-Type: multipart/form-data' \
--form 'source="auto"' \
--form 'target="ko"' \
--form 'glossaryKey="{glossaryKey}"' \
--form 'file=@"{file}"'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
data Object - Response result
data.requestId String - ID issued with the translation request (Request ID)
  • Unique identification value for each document translation request

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:

{
    "data": {
        "requestId": "20240823_1724375809035_033"
    }
}