Set developer key usage limits as an admin

Set developer key usage limits as an admin Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Deepl MCP server": {
    "url": "https://bump.sh/polo/hub/about-mcp/doc/deepl/mcp"
  }
}

PUT /v2/admin/developer-keys/limits

Auth header

application/json

Body Required

key_id string Required

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

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_milliseconds number

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.

Responses

200 application/json

The set usage limits function returns a JSON representation of the modified API key.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
Hide response attributes Show response attributes object
- key_id string
  
  API key ID. Consists of two valid GUIDs separated by a colon.
- label string
  
  API key label. The default value is DeepL API Key.
- creation_time string
  
  Timestamp when the key was created (ISO 8601 format)
- deactivated_time string
  
  Timestamp when the key was deactivated (ISO 8601 format). The default value is null.
- is_deactivated boolean
  
  Flag indicating whether the API key is deactivated. The default value is false.
- usage_limits object
  
  Usage limits for the API key.
  
  Hide usage_limits attributes Show usage_limits attributes object
  
  characters number
  
  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_milliseconds number
  
  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.
400

Bad request. Please check error message and your parameters.
Hide headers attribute Show headers attribute
- 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.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
404

The requested resource could not be found.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.
500

Internal error.
Hide headers attribute Show headers attribute
- X-Trace-ID
  
  A unique identifier for the request that can be included in bug reports to DeepL support.

PUT /v2/admin/developer-keys/limits

curl \
 --request PUT 'https://api.deepl.com/v2/admin/developer-keys/limits' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"key_id":"ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38","characters":5000,"speech_to_text_milliseconds":3600000}'

Request examples

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

Response examples (200)

# Headers

# Payload
{
  "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
  }
}