Authorizations
Authentication with Authorization
header and DeepL-Auth-Key
authentication scheme. Example: DeepL-Auth-Key <api-key>
Body
API key ID. Consists of two valid GUIDs separated by a colon.
"ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38"
Restricts 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.
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.
5000
Response
The set usage limits function returns a JSON representation of the modified API key.
The API key.
API key ID. Consists of two valid GUIDs separated by a colon.
"ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38"
API key label. The default value is DeepL API Key
.
"developer key prod"
Timestamp when the key was created (ISO 8601 format)
"2025-07-08T08:15:29.362Z"
Timestamp when the key was deactivated (ISO 8601 format). The default value is null
.
"2025-07-09T08:15:29.362Z"
Flag indicating whether the API key is deactivated. The default value is false
.
true
Usage limits for the API key.