Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions api-reference/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"name": "DeepL - Contact us",
"url": "https://www.deepl.com/contact-us"
},
"version": "3.13.0"
"version": "3.14.0"
},
"externalDocs": {
"description": "DeepL Pro - Plans and pricing",
Expand Down Expand Up @@ -684,7 +684,7 @@
],
"summary": "Set developer key usage limits as an admin",
"operationId": "adminSetDeveloperKeyUsageLimits",
"description": "Set per-key usage limits for characters and speech-to-text milliseconds. Requests made\nwith the key fail with HTTP 456 once a limit is reached. Requires an Admin API key.",
"description": "Set per-key usage limits for characters, speech-to-text milliseconds, and\nspeech-to-speech milliseconds. Requests made with the key fail with HTTP 456\nonce a limit is reached. Requires an Admin API key.",
"requestBody": {
"required": true,
"content": {
Expand All @@ -703,6 +703,9 @@
},
"speech_to_text_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
},
"speech_to_speech_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds"
}
}
}
Expand Down Expand Up @@ -7146,6 +7149,11 @@
"type": "number",
"example": 3600000
},
"ApiKeyUsageSpeechToSpeechMilliseconds": {
"description": "Restricts the number of milliseconds of speech-to-speech that can be consumed by an API key in a one-month usage period.\nSetting the limit to `0` means the API key will not be able to consume speech-to-speech milliseconds.\nSetting the limit to `null` disables the limit, effectively allowing unlimited usage.\n",
"type": "number",
"example": 3600000
},
"ApiKey": {
"description": "The API key.",
"type": "object",
Expand Down Expand Up @@ -7180,6 +7188,9 @@
},
"speech_to_text_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
},
"speech_to_speech_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds"
}
}
}
Expand Down
18 changes: 15 additions & 3 deletions api-reference/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
contact:
name: DeepL - Contact us
url: https://www.deepl.com/contact-us
version: 3.13.0
version: 3.14.0
externalDocs:
description: DeepL Pro - Plans and pricing
url: https://www.deepl.com/pro#developer
Expand Down Expand Up @@ -544,8 +544,9 @@ paths:
summary: Set developer key usage limits as an admin
operationId: adminSetDeveloperKeyUsageLimits
description: |-
Set per-key usage limits for characters and speech-to-text milliseconds. Requests made
with the key fail with HTTP 456 once a limit is reached. Requires an Admin API key.
Set per-key usage limits for characters, speech-to-text milliseconds, and
speech-to-speech milliseconds. Requests made with the key fail with HTTP 456
once a limit is reached. Requires an Admin API key.
requestBody:
required: true
content:
Expand All @@ -561,6 +562,8 @@ paths:
$ref: '#/components/schemas/ApiKeyUsageCharacters'
speech_to_text_milliseconds:
$ref: '#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds'
speech_to_speech_milliseconds:
$ref: '#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds'
responses:
'200':
description: The set usage limits function returns a JSON representation of the modified API key.
Expand Down Expand Up @@ -5082,6 +5085,13 @@ components:
Setting the limit to `null` disables the limit, effectively allowing unlimited usage.
type: number
example: 3600000
ApiKeyUsageSpeechToSpeechMilliseconds:
description: |
Restricts the number of milliseconds of speech-to-speech 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-speech milliseconds.
Setting the limit to `null` disables the limit, effectively allowing unlimited usage.
type: number
example: 3600000
ApiKey:
description: The API key.
type: object
Expand Down Expand Up @@ -5110,6 +5120,8 @@ components:
$ref: '#/components/schemas/ApiKeyUsageCharacters'
speech_to_text_milliseconds:
$ref: '#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds'
speech_to_speech_milliseconds:
$ref: '#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds'
ConfiguredRules:
description: The enabled rules for the style rule list including what option
was selected for each rule. This schema combines rules from all supported
Expand Down
9 changes: 6 additions & 3 deletions docs/admin/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ You'll receive an array with one object per developer key, active and deactivate
"is_deactivated": false,
"usage_limits": {
"characters": null,
"speech_to_text_milliseconds": null
"speech_to_text_milliseconds": null,
"speech_to_speech_milliseconds": null
}
}
]
Expand Down Expand Up @@ -91,7 +92,8 @@ The response returns the newly created key object:
"is_deactivated": false,
"usage_limits": {
"characters": null,
"speech_to_text_milliseconds": null
"speech_to_text_milliseconds": null,
"speech_to_speech_milliseconds": null
}
}
```
Expand Down Expand Up @@ -126,7 +128,8 @@ The response returns the updated key object. Confirm that `usage_limits.characte
"is_deactivated": false,
"usage_limits": {
"characters": 500000,
"speech_to_text_milliseconds": null
"speech_to_text_milliseconds": null,
"speech_to_speech_milliseconds": null
}
}
```
Expand Down
Loading