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 supported glossary languages

List Language Pairs Supported by Glossaries

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

GEThttps://api.deepl.com/v2/glossary-language-pairs

Authorization

Response

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

Body

supported_languagesarray of object

The list of supported languages

Response

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

Create a glossary

Create a Glossary

POSThttps://api.deepl.com/v2/glossaries

Authorization

Body

name*string

Name to be associated with the glossary.

Example: "My Glossary"

source_lang*GlossarySourceLanguage (enum)

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

Example: "en"

dadeenesfritjakonbnlplptrorusvzh

target_lang*GlossaryTargetLanguage (enum)

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

Example: "de"

dadeenesfritjakonbnlplptrorusvzh

entries*string

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

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.

Example: "tsv"

tsvcsv

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.

Body

glossary_idGlossaryId (string)

A unique ID assigned to a glossary.

Example: "def3a26b-3e84-45b3-84ae-0c0aaf3525f7"

namestring

Name associated with the glossary.

readyboolean

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_langGlossarySourceLanguage (enum)

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

Example: "en"

dadeenesfritjakonbnlplptrorusvzh

target_langGlossaryTargetLanguage (enum)

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

Example: "de"

dadeenesfritjakonbnlplptrorusvzh

creation_timestring (date-time)

The creation time of the glossary in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

entry_countinteger

The number of entries in the glossary.

Response

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

List all glossaries

List all Glossaries

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

GEThttps://api.deepl.com/v2/glossaries

Authorization

Response

JSON object containing a the glossaries.

Body

glossariesarray of Glossary (object)

Response

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

Retrieve glossary details

Retrieve Glossary Details

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

GEThttps://api.deepl.com/v2/glossaries/{glossary_id}

Authorization

Path parameters

glossary_id*string

A unique ID assigned to the glossary.

Response

JSON object containing the glossary meta-information.

Body

glossary_idGlossaryId (string)

A unique ID assigned to a glossary.

Example: "def3a26b-3e84-45b3-84ae-0c0aaf3525f7"

namestring

Name associated with the glossary.

readyboolean

source_langGlossarySourceLanguage (enum)

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

Example: "en"

dadeenesfritjakonbnlplptrorusvzh

target_langGlossaryTargetLanguage (enum)

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

Example: "de"

dadeenesfritjakonbnlplptrorusvzh

creation_timestring (date-time)

The creation time of the glossary in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

entry_countinteger

The number of entries in the glossary.

Response

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

Retrieve glossary entries

Retrieve Glossary Entries

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

GEThttps://api.deepl.com/v2/glossaries/{glossary_id}/entries

Authorization

Path parameters

glossary_id*string

A unique ID assigned to the glossary.

Header parameters

Response

The entries in the requested format.

Body

any

Response

{
  "message": "text",
  "detail": "text"
}

Delete a glossary

Delete a Glossary

Deletes the specified glossary.

DELETEhttps://api.deepl.com/v2/glossaries/{glossary_id}

Authorization

Path parameters

glossary_id*string

A unique ID assigned to the glossary.

Response

Returns no content upon success.

Response

{
  "message": "text",
  "detail": "text"
}

Last updated 2 months ago