ManageGlossaries

Retrieve Glossary Details

Changed on

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

get/v2/glossaries/{glossary_id}

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v2/glossaries/{glossary_id}
  • Auth
    API key in header Authorization

Path parameters

glossary_idstring required

A unique ID assigned to the glossary.

Response

JSON object containing the glossary meta-information.

glossary_idstring

A unique ID assigned to a glossary.

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_lang'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' | 'tr' | 'uk' | 'vi' | 'zh'

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

target_lang'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' | 'tr' | 'uk' | 'vi' | 'zh'

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

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.

Example 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
}

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      removed the th enum value from the response property for the response status

    • info

      removed the th enum value from the response property for the response status