Get started
The Admin API is available only to a limited set of Pro API subscribers. To enable access for your account, please contact your DeepL customer success manager or our support team.
Note that managing admin keys themselves is currently available only in the self-admin area under the
“Admin Keys” tab.
Managing developer keys
The admin API keys allow admins to manage developer API keys through DeepL API. These functionalities are equivalent to those available in the self-admin area under the “API Keys & Limits” tab. The Admin API currently consists of a single endpoint,/v2/admin/developer-keys
, available under our API pro endpoint https://api.deepl.com
.
Create a developer key
POST /v2/admin/developer-keys
You can optionally give an API key a name of your choosing during the creation process. If you do not name the key, the
name “DeepL API Key” will be given to the key automatically.
Up to 25 simultaneously active API keys are allowed.
Example request: Create a developer key as an admin
Example response
Get all developer keys
GET /v2/admin/developer-keys
This method will return both active and deactivated keys.
Example request: Get all developer keys as an admin
Example response
Deactivate a developer key
PUT /v2/admin/developer-keys/deactivate
IMPORTANT: An API key will stop working immediately when deactivated. After a key is deactivated, it cannot be reactivated—deactivating a key is permanent!
:
symbol.
Example request: Deactivate a developer key as an admin
Example response
Rename a developer key
PUT /v2/admin/developer-keys/label
To rename a key, pass its ID in the request and the new label, as shown below.
The key ID is composed of two GUIDs separated by the :
symbol.
Example request: Rename a developer key as an admin
Example response
Set usage limits for a developer key
PUT /v2/admin/developer-keys/limits
Key-level limits restrict the number of total characters (across text translation, document translation, and text
improvement) that can be consumed by an API key in a one-month usage period.
For example, if you set a key-level usage limit of 1,000,000 characters, the API key will not consume more than 1,000,000 characters per usage period.
The character count will “reset” at the start of the next usage period, at which point the key will again be able to consume characters.
As with subscription-level cost control:
- Developers will receive notification emails when 80% and 100% of a key-level limit has been reached
- The API will respond with
456 Quota exceeded
errors when 100% of a key-level limit has been reached
Setting the limit to
0
means the API key will not be able to consume characters.Setting the limit to
null
disables the limit, effectively allowing unlimited usage.Example request: Set usage limits for a developer key as an admin
Example request: Prevent using a developer key as an admin
Example request: Allow unlimited usage of a developer key as an admin
Example response