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 /v2/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.
- 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

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 /v2/glossaries/{glossary_id}

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

Response examples (200)

{
  "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "name": "My Glossary",
  "ready": true,
  "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)"
}