Sign in

v1

latestOpenAPI 3.0.32026-07-265278189.1 KB
AdminApi

Set developer key usage limits as an admin

put/v2/admin/developer-keys/limits

Request body

key_idstring required

API key ID. Consists of two valid GUIDs separated by a colon.

charactersnumber

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.

speech_to_text_millisecondsnumber

Restricts the number of milliseconds of speech-to-text 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 speech-to-text milliseconds. Setting the limit to null disables the limit, effectively allowing unlimited usage.

Example request

{
  "key_id": "ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38",
  "characters": 5000,
  "speech_to_text_milliseconds": 3600000
}

Response

The set usage limits function returns a JSON representation of the modified API key.

key_idstring

API key ID. Consists of two valid GUIDs separated by a colon.

labelstring

API key label. The default value is DeepL API Key.

creation_timestring

Timestamp when the key was created (ISO 8601 format)

deactivated_timestring

Timestamp when the key was deactivated (ISO 8601 format). The default value is null.

is_deactivatedboolean

Flag indicating whether the API key is deactivated. The default value is false.

Example response

{
  "key_id": "ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38",
  "label": "developer key prod",
  "creation_time": "2025-07-08T08:15:29.362Z",
  "deactivated_time": "2025-07-09T08:15:29.362Z",
  "is_deactivated": true,
  "usage_limits": {
    "characters": 5000,
    "speech_to_text_milliseconds": 3600000
  }
}