Retrieve Glossary Details | Deepl API documentation

Retrieve Glossary Details 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"
  }
}

GET /v3/glossaries/{glossary_id}

Auth header

Retrieve meta information for a single glossary, omitting the glossary entries.

Path parameters

glossary_id string Required

A unique ID assigned to the glossary.

Responses

200 application/json

JSON object containing the glossary meta-information.
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.
- dictionaries array[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.
  
  Hide dictionaries attributes Show dictionaries attributes object
  
  A dictionary contained in a multilingual glossary. Each dictionary contains the mapping of source terms to target language terms.
  
  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.
  
  entries string
  
  The entries of the glossary. The entries have to be specified in the format provided by the entries_format parameter.
  
  entries_format string
  
  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.
- 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).
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

Forbidden. The access to the requested resource is denied, because of insufficient access rights.
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.
404

The requested resource could not be found.
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.
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.

GET /v3/glossaries/{glossary_id}

curl \
 --request GET 'https://api.deepl.com/v3/glossaries/{glossary_id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

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