DeepL Web TranslatorCreate Free API AccountContact Us

OpenAPI spec for glossary management

This page was auto-generated from DeepL's OpenAPI file.

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

List Language Pairs Supported by Glossaries

get

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

Authorizations
Responses
200
A JSON object containing the language pairs in its `supported_languages` property.
application/json
{
  "supported_languages": [
    {
      "source_lang": "de",
      "target_lang": "en"
    },
    {
      "source_lang": "en",
      "target_lang": "de"
    }
  ]
}

Create a Glossary

post
Authorizations
Body
namestringRequired

Name to be associated with the glossary.

Example: My Glossary
Responses
201
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.
application/json
{
  "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "name": "My Glossary",
  "dictionaries": [
    {
      "source_lang": "en",
      "target_lang": "de",
      "entry_count": 1
    }
  ],
  "creation_time": "2021-08-03T14:16:18.329Z"
}

List all Glossaries

get

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

Authorizations
Responses
200
JSON object containing a the glossaries.
application/json
{
  "glossaries": [
    {
      "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
      "name": "My Glossary",
      "dictionaries": [
        {
          "source_lang": "EN",
          "target_lang": "DE",
          "entry_count": 1
        },
        {
          "source_lang": "DE",
          "target_lang": "EN",
          "entry_count": 2
        }
      ],
      "creation_time": "2021-08-03T14:16:18.329Z"
    }
  ]
}

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
200
JSON object containing the glossary meta-information.
application/json
{
  "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "name": "My Glossary",
  "dictionaries": [
    {
      "source_lang": "EN",
      "target_lang": "DE",
      "entry_count": 1
    },
    {
      "source_lang": "DE",
      "target_lang": "EN",
      "entry_count": 2
    }
  ],
  "creation_time": "2021-08-03T14:16:18.429Z"
}

Edit glossary details

patch

Edit glossary details, such as name or a dictionary for a source and target language.

Authorizations
Path parameters
glossary_idstringRequired

A unique ID assigned to the glossary.

Body
namestringOptional

A unique ID assigned to a glossary.

Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
Responses
200
JSON object containing the glossary meta-information.
application/json
{
  "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "name": "My Glossary",
  "dictionaries": [
    {
      "source_lang": "EN",
      "target_lang": "DE",
      "creation_time": "2021-08-03T14:16:18.329Z",
      "entry_count": 1
    },
    {
      "source_lang": "DE",
      "target_lang": "EN",
      "creation_time": "2021-08-03T14:16:18.429Z",
      "entry_count": 2
    }
  ]
}

Delete a Glossary

delete

Deletes the specified glossary.

Authorizations
Path parameters
glossary_idstringRequired

A unique ID assigned to the glossary.

Responses
204
Returns no content upon success.
No content

Retrieve Glossary Entries

get

List the entries of a single glossary in tsv format.

Authorizations
Path parameters
glossary_idstringRequired

A unique ID assigned to the glossary.

Query parameters
source_langstring · enumRequired

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

Example: enPossible values:
target_langstring · enumRequired

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

Example: dePossible values:
Responses
200
The entries in tsv, wrapped in a JSON object.
application/json
{
  "source_lang": "en",
  "target_lang": "de",
  "entries": "Hello\tGuten Tag",
  "entries_format": "tsv"
}

Deletes the dictionary associated with the given language pair with the given glossary ID.

delete
Authorizations
Path parameters
glossary_idstringRequired

A unique ID assigned to the glossary.

Query parameters
source_langstring · enumRequired

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

Example: enPossible values:
target_langstring · enumRequired

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

Example: dePossible values:
Responses
204
Returns no content upon success.
No content

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

put
Authorizations
Path parameters
glossary_idstringRequired

A unique ID assigned to the glossary.

Body
source_langstring · enumOptional

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

Example: enPossible values:
target_langstring · enumOptional

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

Example: dePossible values:
entriesstringOptional

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 · enumOptional

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: tsvPossible values:
Responses
200
JSON object containing the dictionary meta-information.
application/json
{
  "source_lang": "EN",
  "target_lang": "DE",
  "entry_count": 1
}

Last updated