Create a glossary

POST /v3/glossaries

Create a Glossary

cURL

curl --request POST \
  --url https://api.deepl.com/v3/glossaries \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Glossary",
  "dictionaries": [
    {
      "source_lang": "en",
      "target_lang": "de",
      "entries": "Hello\tGuten Tag",
      "entries_format": "tsv"
    }
  ]
}
'

201

{
  "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "name": "My Glossary",
  "dictionaries": [
    {
      "source_lang": "en",
      "target_lang": "de",
      "entry_count": 1
    }
  ],
  "creation_time": "2021-08-03T14:16:18.329Z"
}

{
  "message": "Invalid glossary entries provided",
  "detail": "Key with the index 1 (starting at position 13) duplicates key with the index 0 (starting at position 0)"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

{
  "message": "<string>",
  "code": "invalid_content_type"
}

Authorizations

Authorization · string · header · default: DeepL-Auth-Key · required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Body

application/jsonapplication/x-www-form-urlencoded

name · string · required

Name to be associated with the glossary.

Example:

"My Glossary"

dictionaries · object[] · required

Dictionaries to populate the glossary with.

Show child attributes

Response

201

application/json

The function for creating a glossary returns a JSON object containing the ID of the newly created glossary and a boolean flag that indicates if the created glossary can already be used in translate requests.

glossary_id · string

A unique ID assigned to a glossary.

Example:

"def3a26b-3e84-45b3-84ae-0c0aaf3525f7"

name · string

Name associated with the glossary.

dictionaries · object[]

List of dictionaries contained in this glossary. Each dictionary contains a source and target language, as well as pairs of source and target entries.

Show child attributes

creation_time · string<date-time>

The creation time of the glossary in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).