Skip to content

Commit 8c9bf54

Browse files
authored
Merge pull request #472 from DeepL/docs/admin-speech-to-speech-limits
spec: add speech_to_speech_milliseconds to developer key usage limits
2 parents 937851c + 8138ad0 commit 8c9bf54

3 files changed

Lines changed: 34 additions & 8 deletions

File tree

‎api-reference/openapi.json‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"name": "DeepL - Contact us",
99
"url": "https://www.deepl.com/contact-us"
1010
},
11-
"version": "3.13.0"
11+
"version": "3.14.0"
1212
},
1313
"externalDocs": {
1414
"description": "DeepL Pro - Plans and pricing",
@@ -688,7 +688,7 @@
688688
],
689689
"summary": "Set developer key usage limits as an admin",
690690
"operationId": "adminSetDeveloperKeyUsageLimits",
691-
"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.",
691+
"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.",
692692
"requestBody": {
693693
"required": true,
694694
"content": {
@@ -707,6 +707,9 @@
707707
},
708708
"speech_to_text_milliseconds": {
709709
"$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
710+
},
711+
"speech_to_speech_milliseconds": {
712+
"$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds"
710713
}
711714
}
712715
}
@@ -7850,6 +7853,11 @@
78507853
"type": "number",
78517854
"example": 3600000
78527855
},
7856+
"ApiKeyUsageSpeechToSpeechMilliseconds": {
7857+
"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",
7858+
"type": "number",
7859+
"example": 3600000
7860+
},
78537861
"ApiKey": {
78547862
"description": "The API key.",
78557863
"type": "object",
@@ -7884,6 +7892,9 @@
78847892
},
78857893
"speech_to_text_milliseconds": {
78867894
"$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
7895+
},
7896+
"speech_to_speech_milliseconds": {
7897+
"$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds"
78877898
}
78887899
}
78897900
}

‎api-reference/openapi.yaml‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ info:
99
contact:
1010
name: DeepL - Contact us
1111
url: https://www.deepl.com/contact-us
12-
version: 3.13.0
12+
version: 3.14.0
1313
externalDocs:
1414
description: DeepL Pro - Plans and pricing
1515
url: https://www.deepl.com/pro#developer
@@ -557,8 +557,9 @@ paths:
557557
summary: Set developer key usage limits as an admin
558558
operationId: adminSetDeveloperKeyUsageLimits
559559
description: |-
560-
Set per-key usage limits for characters and speech-to-text milliseconds. Requests made
561-
with the key fail with HTTP 456 once a limit is reached. Requires an Admin API key.
560+
Set per-key usage limits for characters, speech-to-text milliseconds, and
561+
speech-to-speech milliseconds. Requests made with the key fail with HTTP 456
562+
once a limit is reached. Requires an Admin API key.
562563
requestBody:
563564
required: true
564565
content:
@@ -574,6 +575,8 @@ paths:
574575
$ref: '#/components/schemas/ApiKeyUsageCharacters'
575576
speech_to_text_milliseconds:
576577
$ref: '#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds'
578+
speech_to_speech_milliseconds:
579+
$ref: '#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds'
577580
responses:
578581
'200':
579582
description: The set usage limits function returns a JSON representation of the modified API key.
@@ -5672,6 +5675,13 @@ components:
56725675
Setting the limit to `null` disables the limit, effectively allowing unlimited usage.
56735676
type: number
56745677
example: 3600000
5678+
ApiKeyUsageSpeechToSpeechMilliseconds:
5679+
description: |
5680+
Restricts the number of milliseconds of speech-to-speech that can be consumed by an API key in a one-month usage period.
5681+
Setting the limit to `0` means the API key will not be able to consume speech-to-speech milliseconds.
5682+
Setting the limit to `null` disables the limit, effectively allowing unlimited usage.
5683+
type: number
5684+
example: 3600000
56755685
ApiKey:
56765686
description: The API key.
56775687
type: object
@@ -5700,6 +5710,8 @@ components:
57005710
$ref: '#/components/schemas/ApiKeyUsageCharacters'
57015711
speech_to_text_milliseconds:
57025712
$ref: '#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds'
5713+
speech_to_speech_milliseconds:
5714+
$ref: '#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds'
57035715
ConfiguredRules:
57045716
description: The enabled rules for the style rule list including what option
57055717
was selected for each rule. This schema combines rules from all supported

‎docs/admin/quickstart.mdx‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ You'll receive an array with one object per developer key, active and deactivate
5959
"is_deactivated": false,
6060
"usage_limits": {
6161
"characters": null,
62-
"speech_to_text_milliseconds": null
62+
"speech_to_text_milliseconds": null,
63+
"speech_to_speech_milliseconds": null
6364
}
6465
}
6566
]
@@ -91,7 +92,8 @@ The response returns the newly created key object:
9192
"is_deactivated": false,
9293
"usage_limits": {
9394
"characters": null,
94-
"speech_to_text_milliseconds": null
95+
"speech_to_text_milliseconds": null,
96+
"speech_to_speech_milliseconds": null
9597
}
9698
}
9799
```
@@ -126,7 +128,8 @@ The response returns the updated key object. Confirm that `usage_limits.characte
126128
"is_deactivated": false,
127129
"usage_limits": {
128130
"characters": 500000,
129-
"speech_to_text_milliseconds": null
131+
"speech_to_text_milliseconds": null,
132+
"speech_to_speech_milliseconds": null
130133
}
131134
}
132135
```

0 commit comments

Comments
 (0)