# Create a Glossary

**POST /v2/glossaries**




## Servers
- DeepL API Pro: https://api.deepl.com (DeepL API Pro)
- DeepL API Free: https://api-free.deepl.com (DeepL API Free)


## Authentication methods
- Auth header


## Parameters



### Body: application/json (object)

- **name** (string)
  Name to be associated with the glossary.

- **source_lang** (string)
  The language in which the source texts in the glossary are specified.

- **target_lang** (string)
  The language in which the target texts in the glossary are specified.

- **entries** (string)
  The entries of the glossary. The entries have to be specified in the format provided by the `entries_format` parameter.

- **entries_format** (string)
  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](https://www.deepl.com/docs-api/glossaries/formats) for details about each format.



## 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.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


#### Body: application/json (object)
- **glossary_id** (string)
  A unique ID assigned to a glossary.

- **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** (string)
  The language in which the source texts in the glossary are specified.

- **target_lang** (string)
  The language in which the target texts in the glossary are specified.

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


### 400
Bad request. Please check error message and your parameters.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


#### Body: application/json (object)
- **message** (string)
  Generic description of the error.

- **detail** (string)
  More specific description of the error.


### 401
Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 403
Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 413
The request size exceeds the limit.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 429
Too many requests. Please wait and resend your request.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 456
Quota exceeded. The glossary creation limit has been reached.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 500
Internal error.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 503
Resource currently unavailable. Try again later.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 529
Too many requests. Please wait and resend your request.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.



[Powered by Bump.sh](https://bump.sh)