Create glossary

Prev Next

Available in Classic and VPC

Create a glossary. The glossary helps you maintain translation consistency when using Papago Text Translation and Papago Doc Translation. You can manage glossaries through the API and in the NAVER Cloud Platform console.

Note

For more information on how to manage glossaries in the NAVER Cloud Platform console, see Glossary in the Papago Text Translation user guide.

Request

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

Method URI
POST /create

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
glossaryName String Required Glossary name
  • Up to 20 characters
description String Optional Glossary description
  • Up to 50 characters

Request example

The request example is as follows:

curl --location --request POST 'https://papago.apigw.ntruss.com/glossary/v1/create' \
--header 'x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}' \
--header 'x-ncp-iam-access-key: {x-ncp-iam-access-key}' \
--header 'x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}' \
--header 'Content-Type: application/json' \
--data '{
    "glossaryName": "GlossaryTest1",
    "description": "This is a description of the GlossaryTest1 glossary."
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
data Object - Glossary creation details
data.glossaryKey String - Glossary ID

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": {
        "glossaryKey": "{glossaryKey}"
    }
}