Skip to content

spec: add speech-to-speech to the admin API #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lilkraftwerk wants to merge 3 commits into
base: main
Choose a base branch
from
+47 −5
Draft

spec: add speech-to-speech to the admin API #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b0ad09
spec: add speech-to-speech to admin developer-key usage limits
Jun 30, 2026
7706aa6
spec: add speech-to-speech to the admin analytics report
Jul 22, 2026
606a44c
chore: update OpenAPI JSON files from YAML sources
lilkraftwerk Jul 22, 2026
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
28 changes: 24 additions & 4 deletions api-reference/openapi.json
View file
Open in desktop
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.12.0"
"version": "3.13.0"
},
"externalDocs": {
"description": "DeepL Pro - Plans and pricing",
Expand Down Expand Up @@ -150,7 +150,8 @@
"text_translation_characters": 4892,
"document_translation_characters": 0,
"text_improvement_characters": 4727,
"speech_to_text_minutes": 107.46
"speech_to_text_minutes": 107.46,
"speech_to_speech_minutes": 42.11
},
"group_by": "key_and_day",
"start_date": "2025-09-29T00:00:00",
Expand All @@ -165,7 +166,8 @@
"text_translation_characters": 159,
"document_translation_characters": 0,
"text_improvement_characters": 156,
"speech_to_text_minutes": 11.94
"speech_to_text_minutes": 11.94,
"speech_to_speech_minutes": 3.72
}
}
]
Expand All @@ -181,7 +183,8 @@
"text_translation_characters": 4892,
"document_translation_characters": 0,
"text_improvement_characters": 4727,
"speech_to_text_minutes": 107.46
"speech_to_text_minutes": 107.46,
"speech_to_speech_minutes": 42.11
},
"start_date": "2025-09-29T00:00:00",
"end_date": "2025-10-01T00:00:00"
Expand Down Expand Up @@ -668,6 +671,7 @@
],
"summary": "Set developer key usage limits as an admin",
"operationId": "adminSetDeveloperKeyUsageLimits",
"description": "Sets the usage limits for a developer key. This replaces all limits for the key: any\nlimit omitted from the request is reset to `null` (disabled). To change one limit while\nkeeping the others, include their current values in the request.\n",
"requestBody": {
"required": true,
"content": {
Expand All @@ -686,6 +690,9 @@
},
"speech_to_text_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
},
"speech_to_speech_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds"
}
}
}
Expand Down Expand Up @@ -6261,6 +6268,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 @@ -6295,6 +6307,9 @@
},
"speech_to_text_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
},
"speech_to_speech_milliseconds": {
"$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds"
}
}
}
Expand Down Expand Up @@ -9220,6 +9235,11 @@
"type": "number",
"description": "Duration of speech-to-text usage in minutes.",
"example": 107.46
},
"speech_to_speech_minutes": {
"type": "number",
"description": "Duration of speech-to-speech usage in minutes.",
"example": 42.11
}
}
},
Expand Down
24 changes: 23 additions & 1 deletion api-reference/openapi.yaml
View file
Open in desktop
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.12.0
version: 3.13.0
externalDocs:
description: DeepL Pro - Plans and pricing
url: https://www.deepl.com/pro#developer
Expand Down Expand Up @@ -164,6 +164,7 @@ paths:
document_translation_characters: 0
text_improvement_characters: 4727
speech_to_text_minutes: 107.46
speech_to_speech_minutes: 42.11
group_by: "key_and_day"
start_date: "2025-09-29T00:00:00"
end_date: "2025-10-01T00:00:00"
Expand All @@ -177,6 +178,7 @@ paths:
document_translation_characters: 0
text_improvement_characters: 156
speech_to_text_minutes: 11.94
speech_to_speech_minutes: 3.72
withoutGrouping:
summary: Usage report without grouping
value:
Expand All @@ -187,6 +189,7 @@ paths:
document_translation_characters: 0
text_improvement_characters: 4727
speech_to_text_minutes: 107.46
speech_to_speech_minutes: 42.11
start_date: "2025-09-29T00:00:00"
end_date: "2025-10-01T00:00:00"
400:
Expand Down Expand Up @@ -498,6 +501,10 @@ paths:
- AdminApi
summary: Set developer key usage limits as an admin
operationId: adminSetDeveloperKeyUsageLimits
description: |
Sets the usage limits for a developer key. This replaces all limits for the key: any
limit omitted from the request is reset to `null` (disabled). To change one limit while
keeping the others, include their current values in the request.
requestBody:
required: true
content:
Expand All @@ -513,6 +520,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 @@ -4274,6 +4283,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 @@ -4302,6 +4318,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 Expand Up @@ -6815,6 +6833,10 @@ components:
type: number
description: Duration of speech-to-text usage in minutes.
example: 107.46
speech_to_speech_minutes:
type: number
description: Duration of speech-to-speech usage in minutes.
example: 42.11
KeyAndDayUsageItem:
type: object
description: Usage statistics for a specific API key and optionally a specific date.
Expand Down