Replaces or creates a dictionary in the glossary with the specified entries.

Replaces or creates a dictionary in the glossary with the specified entries. 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"
  }
}

PUT /v3/glossaries/{glossary_id}/dictionaries

Auth header

Path parameters

glossary_id string Required

A unique ID assigned to the glossary.

Body

The dictionary to insert into (or overwrite in) the multilingual glossary.

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.

Body

The dictionary to insert into (or overwrite in) the multilingual glossary.

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.

Responses

200 application/json

JSON object containing the dictionary 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
- 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.
- 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.
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.

PUT /v3/glossaries/{glossary_id}/dictionaries

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

curl \
 --request PUT 'https://api.deepl.com/v3/glossaries/{glossary_id}/dictionaries' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'source_lang=en&target_lang=de&entries=Hello%09Guten+Tag&entries_format=tsv'

Request examples

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

Response examples (200)

{
  "source_lang": "EN",
  "target_lang": "DE",
  "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)"
}