Create a Glossary
curl --request POST \
  --url 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"
}'
{
  "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
}

Authorizations

​
Authorization
string
header
required

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

Body

​
name
string
required

Name to be associated with the glossary.

Example:

"My Glossary"

​
source_lang
enum<string>
required

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

Available options:
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,
zh
Example:

"en"

​
target_lang
enum<string>
required

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

Available options:
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,
zh
Example:

"de"

​
entries
string
required

The entries of the glossary. The entries have to be specified in the format provided by the entries_format parameter.

Example:

"Hello\tGuten Tag"

​
entries_format
enum<string>
default:tsv
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.

Available options:
tsv,
csv
Example:

"tsv"

Response

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.

​
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
enum<string>

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

Available options:
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,
zh
Example:

"en"

​
target_lang
enum<string>

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

Available options:
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,
zh
Example:

"de"

​
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.