Create a Glossary | Deepl API documentation

Create a Glossary Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Deepl MCP server": {
    "url": "https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp"
  }
}

POST /v2/glossaries

Auth header

Body Required

name string Required

Name to be associated with the glossary.
source_lang string Required

The language in which the source texts in the glossary are specified.

Values are ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sv, th, tr, uk, vi, or zh.
target_lang string Required

The language in which the target texts in the glossary are specified.

Values are ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sv, th, tr, uk, vi, or zh.
entries string Required

The entries of the glossary. The entries have to be specified in the format provided by the entries_format parameter.
entries_format string Required
The format in which the glossary entries are provided. Formats currently available:
- tsv (default) - tab-separated values
- csv - comma-separated values
See Supported Glossary Formats for details about each format.
Values are tsv or csv. Default value is tsv.

Body Required

name string Required

Name to be associated with the glossary.
source_lang string Required

The language in which the source texts in the glossary are specified.

Values are ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sv, th, tr, uk, vi, or zh.
target_lang string Required

The language in which the target texts in the glossary are specified.

Values are ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sv, th, tr, uk, vi, or zh.
entries string Required

The entries of the glossary. The entries have to be specified in the format provided by the entries_format parameter.
entries_format string Required
The format in which the glossary entries are provided. Formats currently available:
- tsv (default) - tab-separated values
- csv - comma-separated values
See Supported Glossary Formats for details about each format.
Values are tsv or csv. Default value is tsv.

Responses

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.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
Hide response attributes Show response attributes object
- glossary_id string
  
  A unique ID assigned to a glossary.
- name string
  
  Name associated with the glossary.
- ready boolean
  
  Indicates if the newly created glossary can already be used in translate requests. If the created glossary is not yet ready, you have to wait and check the ready status of the glossary before using it in a translate request.
- source_lang string
  
  The language in which the source texts in the glossary are specified.
  
  Values are ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sv, th, tr, uk, vi, or zh.
- target_lang string
  
  The language in which the target texts in the glossary are specified.
  
  Values are ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hu, id, it, ja, ko, lt, lv, nb, nl, pl, pt, ro, ru, sk, sl, sv, th, tr, uk, vi, or zh.
- 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).
- entry_count integer
  
  The number of entries in the glossary.
400 application/json

Bad request. Please check error message and your parameters.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
Hide response attributes Show response attributes object
- message string
  
  Generic description of the error.
- detail string
  
  More specific description of the error.
401

Authorization failed. Please supply a valid DeepL-Auth-Key via the Authorization header.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
403

Authorization failed. Please supply a valid DeepL-Auth-Key via the Authorization header.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
413

The request size exceeds the limit.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
429

Too many requests. Please wait and resend your request.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
456

Quota exceeded. The glossary creation limit has been reached.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
500

Internal error.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
503

Resource currently unavailable. Try again later.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
529

Too many requests. Please wait and resend your request.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.

POST /v2/glossaries

curl \
 --request POST 'https://api.deepl.com/v2/glossaries' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"My Glossary","source_lang":"en","target_lang":"de","entries":"Hello\tGuten Tag","entries_format":"tsv"}'

curl \
 --request POST 'https://api.deepl.com/v2/glossaries' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'name=My+Glossary&source_lang=en&target_lang=de&entries=Hello%09Guten+Tag&entries_format=tsv'

Request example

{
  "name": "My Glossary",
  "source_lang": "en",
  "target_lang": "de",
  "entries": "Hello\tGuten Tag",
  "entries_format": "tsv"
}

Response examples (201)

# Headers

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

Response examples (400)

{
  "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)"
}