DeepL Web TranslatorCreate Free API AccountContact Us

OpenAPI spec for glossary management

This page contains only a set of guides that is auto-generated from DeepL's OpenAPI file.

For more detail about glossary management, including information about request parameters, please see the Manage glossaries entry.

List Language Pairs Supported by Glossaries

get

Retrieve the list of language pairs supported by the glossary feature.

Authorizations
Responses
{
  "supported_languages": [
    {
      "source_lang": "de",
      "target_lang": "en"
    },
    {
      "source_lang": "en",
      "target_lang": "de"
    }
  ]
}

A JSON object containing the language pairs in its supported_languages property.

Create a glossary

Create a Glossary

post
Authorizations
Body
namestringrequired

Name to be associated with the glossary.

Example: My Glossary
source_langstring · enumrequired

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

Example: enAvailable options:
target_langstring · enumrequired

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

Example: deAvailable options:
entriesstringrequired

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

Example: Hello Guten Tag
entries_formatstring · enumrequired

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.

Default: tsvExample: tsvAvailable options:
Responses
{
  "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
}

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.

List all glossaries

List all Glossaries

get

List all glossaries and their meta-information, but not the glossary entries.

Authorizations
Responses
{
  "glossaries": [
    {
      "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
    }
  ]
}

JSON object containing a the glossaries.

Retrieve Glossary Details

get

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

Authorizations
Path parameters
glossary_idstringrequired

A unique ID assigned to the glossary.

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

JSON object containing the glossary meta-information.

Retrieve Glossary Entries

get

List the entries of a single glossary in the format specified by the Accept header.

Authorizations
Path parameters
glossary_idstringrequired

A unique ID assigned to the glossary.

Header parameters
Acceptstring · enumoptional

The requested format of the returned glossary entries. Currently, supports only text/tab-separated-values.

Default: text/tab-separated-valuesExample: {"summary":"Tab-separated Values","value":{"in":"header","Accept":"text/tab-separated-values"}}Available options:
Responses
Hello!	Guten Tag!

The entries in the requested format.

Delete a Glossary

delete

Deletes the specified glossary.

Authorizations
Path parameters
glossary_idstringrequired

A unique ID assigned to the glossary.

Responses
No Content

Returns no content upon success.

Last updated