diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 00660a51..0350642c 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -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", @@ -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": { @@ -703,6 +703,9 @@ }, "speech_to_text_milliseconds": { "$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds" + }, + "speech_to_speech_milliseconds": { + "$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds" } } } @@ -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", @@ -7180,6 +7188,9 @@ }, "speech_to_text_milliseconds": { "$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds" + }, + "speech_to_speech_milliseconds": { + "$ref": "#/components/schemas/ApiKeyUsageSpeechToSpeechMilliseconds" } } } diff --git a/api-reference/openapi.yaml b/api-reference/openapi.yaml index 0759ac59..ad9eed7a 100644 --- a/api-reference/openapi.yaml +++ b/api-reference/openapi.yaml @@ -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 @@ -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: @@ -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. @@ -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 @@ -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 diff --git a/docs/admin/quickstart.mdx b/docs/admin/quickstart.mdx index c4657461..b7f51531 100644 --- a/docs/admin/quickstart.mdx +++ b/docs/admin/quickstart.mdx @@ -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 } } ] @@ -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 } } ``` @@ -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 } } ```