Skip to content

Commit be92815

Browse files
chore(api): document throttling and model overload responses — SDK-235 (openai#3803)
## Summary Document client throttling and model overload responses for moderation and video requests. ## Changes - Clarify the 429 slow_down and 503 server_is_overloaded response contracts - Document the optional minimum wait before retrying Co-authored-by: markstuart-oai <323302876+markstuart-oai@users.noreply.github.com>
1 parent 2a98f6a commit be92815

2 files changed

Lines changed: 20 additions & 10 deletions

File tree

‎.castiron.stats.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
schema_version: 1
2-
generation_id: c8545f55-7807-4037-9c86-3784b96f3960
3-
openapi_spec_hash: 0f07f47154153d68e717ae594b07dc4c
4-
openapi_transformed_spec_hash: a1a351d4356d65a15a857d0aca5f7b09
2+
generation_id: a363d41d-c644-4a27-a570-9e8b5dcfd77e
3+
openapi_spec_hash: 731db0c2d22643699b8fbff49661822a
4+
openapi_transformed_spec_hash: d934ec81f1cae9e4b5eb061f1da4fe3d
55
config_hash: dfe8a20c64cc5d852e69c441cbd28ae7
6-
codegen_sha: 1d8024b3eb37e3e329104029ed81fd2085ff1218
6+
codegen_sha: cc61526d915d18b4e4216f7b5bb87af48cf75a4e
77
codegen_hash: e1ee819da91a6c8ae8c8af8c4e3054f52eaec918912e9be3b2bd6bc692608d5e
8-
public_codegen_sha: 67cbc9398ec6c0feb5bad24421b648b42bbc405f
8+
public_codegen_sha: 97c26a059ea758356d8f1e6b2ebf36504aa91ba2

‎api_reference/openapi.transformed.yml‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8406,7 +8406,9 @@ paths:
84068406
schema:
84078407
$ref: '#/components/schemas/CreateModerationResponse'
84088408
'429':
8409-
$ref: '#/components/responses/TooManyRequests'
8409+
$ref: '#/components/responses/InferenceRateLimited'
8410+
'503':
8411+
$ref: '#/components/responses/InferenceServiceUnavailable'
84108412
x-oaiMeta:
84118413
name: Create moderation
84128414
group: moderations
@@ -22881,7 +22883,9 @@ paths:
2288122883
schema:
2288222884
$ref: '#/components/schemas/VideoResource'
2288322885
'429':
22884-
$ref: '#/components/responses/TooManyRequests'
22886+
$ref: '#/components/responses/InferenceRateLimited'
22887+
'503':
22888+
$ref: '#/components/responses/InferenceServiceUnavailable'
2288522889
deprecated: true
2288622890
x-oaiMeta:
2288722891
name: Create video
@@ -23153,7 +23157,9 @@ paths:
2315323157
schema:
2315423158
$ref: '#/components/schemas/VideoResource'
2315523159
'429':
23156-
$ref: '#/components/responses/TooManyRequests'
23160+
$ref: '#/components/responses/InferenceRateLimited'
23161+
'503':
23162+
$ref: '#/components/responses/InferenceServiceUnavailable'
2315723163
deprecated: true
2315823164
description: Create a new video generation job by editing a source video or existing generated video.
2315923165
/videos/extensions:
@@ -23176,7 +23182,9 @@ paths:
2317623182
schema:
2317723183
$ref: '#/components/schemas/VideoResource'
2317823184
'429':
23179-
$ref: '#/components/responses/TooManyRequests'
23185+
$ref: '#/components/responses/InferenceRateLimited'
23186+
'503':
23187+
$ref: '#/components/responses/InferenceServiceUnavailable'
2318023188
deprecated: true
2318123189
description: Create an extension of a completed video.
2318223190
/videos/{video_id}:
@@ -23503,7 +23511,9 @@ paths:
2350323511
schema:
2350423512
$ref: '#/components/schemas/VideoResource'
2350523513
'429':
23506-
$ref: '#/components/responses/TooManyRequests'
23514+
$ref: '#/components/responses/InferenceRateLimited'
23515+
'503':
23516+
$ref: '#/components/responses/InferenceServiceUnavailable'
2350723517
deprecated: true
2350823518
x-oaiMeta:
2350923519
name: Remix video

0 commit comments

Comments
 (0)