diff --git a/.castiron.stats.yml b/.castiron.stats.yml index 5f1d907ad..871b55491 100644 --- a/.castiron.stats.yml +++ b/.castiron.stats.yml @@ -1,8 +1,8 @@ schema_version: 1 -generation_id: 2cb6287b-74fd-4ffe-836e-359c0bf21e19 -openapi_spec_hash: 188e635ec266a07f1ef188d7ed905bde -openapi_transformed_spec_hash: e389b9730464603779059a897ec940f9 +generation_id: e97202bd-f0a6-453e-a0f0-f0c2d086cf76 +openapi_spec_hash: a9d8f8060cd41e0e646dbb32e0a67e9e +openapi_transformed_spec_hash: e7979dc13e15e92a7aea26ea4149b6c9 config_hash: 38c35bf82be025557d8a7dc727060f2f -codegen_sha: e023fa823e554e7f0756b6c8099ffa33363b546f +codegen_sha: f034e35a5b044ea83f51566174dc494174da39a4 codegen_hash: 6e92ca97386a94172e8c392ad85e944e5e8aabc7e38218892f34db18a4d3fa02 -public_codegen_sha: f1b4c32c2634ddd648fb92f253febc0840dbb5e9 +public_codegen_sha: b9258025e76c76c44757193cbdda35aeb7e4d91a diff --git a/api_reference/openapi.transformed.yml b/api_reference/openapi.transformed.yml index 04586c1ff..2137275fe 100644 --- a/api_reference/openapi.transformed.yml +++ b/api_reference/openapi.transformed.yml @@ -601,22 +601,19 @@ paths: schema: type: string format: binary - text/event-stream: - schema: - $ref: '#/components/schemas/CreateSpeechResponseStreamEvent' - audio/aac: + audio/mpeg: schema: type: string format: binary - audio/flac: + audio/aac: schema: type: string format: binary - audio/mpeg: + audio/opus: schema: type: string format: binary - audio/opus: + audio/flac: schema: type: string format: binary @@ -628,6 +625,9 @@ paths: schema: type: string format: binary + text/event-stream: + schema: + $ref: '#/components/schemas/CreateSpeechResponseStreamEvent' '400': description: Invalid speech request, input, output format, or voice. content: @@ -769,12 +769,12 @@ paths: - $ref: '#/components/schemas/CreateTranscriptionResponseVerboseJson' discriminator: propertyName: task - text/event-stream: - schema: - $ref: '#/components/schemas/CreateTranscriptionResponseStreamEvent' text/plain: schema: type: string + text/event-stream: + schema: + $ref: '#/components/schemas/CreateTranscriptionResponseStreamEvent' '400': description: Invalid audio input or request parameters. content: @@ -1490,6 +1490,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VoiceConsentResource' + '400': + description: Invalid consent recording or consent phrase. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The endpoint is unavailable to this caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: audio examples: @@ -1530,6 +1542,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VoiceConsentListResource' + '400': + description: Invalid pagination parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The endpoint is unavailable or the pagination cursor was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: audio examples: @@ -1558,6 +1582,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VoiceConsentResource' + '400': + description: Invalid consent recording ID. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The endpoint is unavailable or the consent recording was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: audio examples: @@ -1591,6 +1627,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VoiceConsentResource' + '400': + description: Invalid consent recording ID or update. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The endpoint is unavailable or the consent recording was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: audio examples: @@ -1623,6 +1671,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VoiceConsentDeletedResource' + '400': + description: Invalid consent recording ID. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The endpoint is unavailable or the consent recording was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: audio examples: @@ -1651,6 +1711,24 @@ paths: application/json: schema: $ref: '#/components/schemas/VoiceResource' + '400': + description: Invalid voice request, consent recording, or audio sample. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The endpoint is unavailable or the consent recording was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The audio sample could not be processed or the voice could not be created. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: audio examples: @@ -2252,8 +2330,43 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/CreateChatCompletionStreamResponse' + '400': + description: Invalid chat completion request or incompatible request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Authentication failed because the API key is missing or revoked, or the client IP is not authorized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + type: string + description: JSON-encoded error text containing an error object and the HTTP status. + '403': + description: Access to a personal API organization is blocked by the organization policy. + content: + text/plain: + schema: + type: string + description: JSON-encoded error text containing an error object and the HTTP status. + '404': + description: The requested model or a referenced resource was not found or is unavailable to this caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The chat completion could not be processed due to an internal error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -3440,8 +3553,43 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateCompletionResponse' + '400': + description: Invalid completion request or incompatible request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Authentication failed because the API key is missing or revoked, or the client IP is not authorized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + type: string + description: JSON-encoded error text containing an error object and the HTTP status. + '403': + description: Access to a personal API organization is blocked by the organization policy. + content: + text/plain: + schema: + type: string + description: JSON-encoded error text containing an error object and the HTTP status. + '404': + description: The requested model was not found, is unavailable, or does not support this endpoint. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The completion could not be processed due to an internal error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -3608,6 +3756,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ContainerListResource' + '404': + description: The container specified by `after` was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3657,6 +3811,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ContainerResource' + '400': + description: The container configuration or supplied skill is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3723,6 +3883,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ContainerResource' + '404': + description: The container was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3761,6 +3927,12 @@ paths: responses: '200': description: OK + '404': + description: The container was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3807,6 +3979,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ContainerFileResource' + '400': + description: The file input is invalid, or the container file limit would be exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The container was not found or has expired. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3869,6 +4053,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ContainerFileListResource' + '404': + description: The container was not found or has expired, or the file specified by `after` was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3920,6 +4110,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ContainerFileResource' + '404': + description: The container was not found or has expired, or the file was not found in the container. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3958,6 +4154,12 @@ paths: responses: '200': description: OK + '404': + description: The container was not found or has expired, or the file was not found in the container. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -3993,6 +4195,12 @@ paths: responses: '200': description: Success + '404': + description: The container was not found or has expired, or the file was not found in the container. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -4052,8 +4260,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationItemList' + '400': + description: The items are invalid, are already in the conversation, or the conversation is locked. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The conversation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The conversation update could not be finalized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: conversations path: create-item @@ -4248,6 +4474,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationItemList' + '400': + description: The stored encrypted item content could not be validated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The conversation or the item specified by `after` was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -4340,6 +4578,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationItem' + '404': + description: The conversation or the item in that conversation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -4416,8 +4660,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationResource' + '400': + description: The item cannot be removed while the conversation is locked. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The conversation or the item in that conversation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The conversation update could not be finalized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: conversations path: delete-item @@ -4481,17 +4743,46 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateEmbeddingResponse' - '429': - $ref: '#/components/responses/InferenceRateLimited' - '503': - $ref: '#/components/responses/InferenceServiceUnavailable' - x-oaiMeta: - group: embeddings - examples: - request: - curl: | - curl https://api.openai.com/v1/embeddings \ - -H "Authorization: Bearer $OPENAI_API_KEY" \ + '400': + description: Invalid embedding input or request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Authentication failed because the API key is missing or revoked, or the client IP is not authorized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + type: string + description: JSON-encoded error text containing an error object and the HTTP status. + '403': + description: Access to a personal API organization is blocked by the organization policy. + content: + text/plain: + schema: + type: string + description: JSON-encoded error text containing an error object and the HTTP status. + '429': + $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The embedding request could not be processed due to an internal error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '503': + $ref: '#/components/responses/InferenceServiceUnavailable' + x-oaiMeta: + group: embeddings + examples: + request: + curl: | + curl https://api.openai.com/v1/embeddings \ + -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "input": "The food was delicious and the waiter...", @@ -4731,6 +5022,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' + '400': + description: The evaluation input or grader configuration is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -4912,6 +5209,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' + '404': + description: The evaluation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -5014,6 +5317,18 @@ paths: application/json: schema: $ref: '#/components/schemas/Eval' + '400': + description: The evaluation name or metadata is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The evaluation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -5128,12 +5443,18 @@ paths: - object - deleted - eval_id + '400': + description: The evaluation cannot be deleted while it has unfinished runs. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '404': description: Evaluation not found. content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -5220,6 +5541,18 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRunList' + '400': + description: The run list parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The evaluation or the run specified by `after` was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -5356,9 +5689,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The evaluation or a referenced resource was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The evaluation run could not be created. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: evals examples: @@ -5540,6 +5885,18 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRun' + '400': + description: The evaluation run does not belong to the specified evaluation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The evaluation or evaluation run was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -5953,12 +6310,18 @@ paths: run_id: type: string example: evalrun_677469f564d48190807532a852da3afb + '400': + description: The evaluation run cannot be deleted until it is finished. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '404': description: Run not found content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -6058,6 +6421,18 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRunOutputItemList' + '400': + description: The output item list parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The evaluation or evaluation run was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -6192,6 +6567,18 @@ paths: application/json: schema: $ref: '#/components/schemas/EvalRunOutputItem' + '400': + description: The output item was not found, its identifier is invalid, or the run does not belong to the evaluation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The evaluation or evaluation run was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -8330,8 +8717,32 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/ImageEditStreamEvent' + '400': + description: Invalid image request, including invalid DALL-E parameters or input. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The project does not have access to the requested model. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '410': + description: The requested DALL-E image endpoint is unavailable because it has been retired. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The image could not be generated or processed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -8507,8 +8918,32 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/ImageGenStreamEvent' + '400': + description: Invalid image request, including invalid DALL-E parameters or input. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The project does not have access to the requested model. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '410': + description: The requested DALL-E image endpoint is unavailable because it has been retired. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The image could not be generated or processed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -8645,6 +9080,50 @@ paths: application/json: schema: $ref: '#/components/schemas/ImagesResponse' + '400': + description: Invalid image or request, or the request cannot be processed for this account. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The project does not have access to the requested model. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '410': + description: The image variations endpoint is no longer available. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The image rate limit was exceeded. + headers: + X-RateLimit-Limit-Images: + description: The image limit for the rate-limit window. + schema: + type: number + X-RateLimit-Remaining-Images: + description: The number of images remaining in the rate-limit window. + schema: + type: number + minimum: 0 + X-RateLimit-Reset-Images: + description: The number of seconds until the rate-limit window resets. + schema: + type: integer + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The image variation could not be generated or processed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: images examples: @@ -8729,6 +9208,45 @@ paths: transport: type: webrtc sdp: + '400': + description: Invalid Live session request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + type: string + '413': + description: The Live session request exceeds the supported size limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + type: string + '429': + description: The session could not start because a rate or quota limit was exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string + '503': + description: The session is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + text/plain: + schema: + type: string x-oaiMeta: group: live returns: Returns 201 Created with the session identifier in session.id and SDP answer in transport.sdp. @@ -8762,36 +9280,108 @@ paths: responses: '200': description: Session accept request accepted. - x-oaiMeta: - group: live-sessions - returns: Returns 200 OK when the control request succeeds. - /live/sessions/{session_id}/fork: - post: - operationId: fork-live-session - summary: Fork session - description: Fork a stored Live session onto a new WebRTC connection. - tags: - - Live - parameters: - - in: path - name: session_id - required: true - schema: - type: string - description: The ID of the stored Live session to fork. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/LiveForkRequest' - responses: - '201': - description: Forked Live session created with a WebRTC answer. + '400': + description: Invalid request body or headers. content: application/json: schema: - $ref: '#/components/schemas/LiveCreateResponse' + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The session or call can no longer accept this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The session could not start because a rate or quota limit was exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string + '503': + description: The session is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + x-oaiMeta: + group: live-sessions + returns: Returns 200 OK when the control request succeeds. + /live/sessions/{session_id}/fork: + post: + operationId: fork-live-session + summary: Fork session + description: Fork a stored Live session onto a new WebRTC connection. + tags: + - Live + parameters: + - in: path + name: session_id + required: true + schema: + type: string + description: The ID of the stored Live session to fork. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LiveForkRequest' + responses: + '201': + description: Forked Live session created with a WebRTC answer. + content: + application/json: + schema: + $ref: '#/components/schemas/LiveCreateResponse' + '400': + description: Invalid Live session request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Invalid session ID. + content: + text/plain: + schema: + type: string + '413': + description: The Live session request exceeds the supported size limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The session could not start because a rate or quota limit was exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string + '503': + description: The session is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: live returns: The new session identifier in session.id and SDP answer in transport.sdp. @@ -8819,6 +9409,12 @@ paths: responses: '200': description: Session hangup request accepted. + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: live-sessions returns: Returns 200 OK when the control request succeeds. @@ -8845,6 +9441,24 @@ paths: responses: '200': description: Session refer request accepted. + '400': + description: Invalid request body or headers. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string x-oaiMeta: group: live-sessions returns: Returns 200 OK when the control request succeeds. @@ -8871,6 +9485,30 @@ paths: responses: '200': description: Session reject request accepted. + '400': + description: Invalid request body or headers. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The session or call can no longer accept this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string x-oaiMeta: group: live-sessions returns: Returns 200 OK when the control request succeeds. @@ -9124,8 +9762,26 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateModerationResponse' + '400': + description: Invalid moderation input or unsupported request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Access to the requested moderation model was denied. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The moderation request could not be processed due to an internal error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -9390,6 +10046,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiKeyList' + '400': + description: The API key listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' x-oaiMeta: group: administration examples: @@ -9455,6 +10123,24 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminApiKeyCreateResponse' + '400': + description: The API key creation request is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The created API key could not be found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -9507,6 +10193,18 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminApiKey' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The API key was not found or is not available to this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -9569,6 +10267,18 @@ paths: - id - object - deleted + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The API key was not found or is not available to this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -9686,6 +10396,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ListAuditLogsResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: No audit log was found with the specified pagination cursor. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -9798,6 +10520,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ListCertificatesResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -9852,6 +10586,18 @@ paths: application/json: schema: $ref: '#/components/schemas/Certificate' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -9903,8 +10649,32 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationCertificateActivationResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A certificate was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The certificate update could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -9970,8 +10740,32 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationCertificateDeactivationResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A certificate was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The certificate update could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10047,6 +10841,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Certificate' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A certificate was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10098,8 +10910,32 @@ paths: application/json: schema: $ref: '#/components/schemas/Certificate' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A certificate was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The certificate update could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10147,6 +10983,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteCertificateResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A certificate was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10248,6 +11102,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10301,6 +11167,18 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationDataRetention' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The organization was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10336,6 +11214,24 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationDataRetention' + '400': + description: The requested data retention setting or transition is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The organization was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10396,6 +11292,24 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10443,8 +11357,38 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: The organization has reached its maximum number of groups. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The group operation could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10487,8 +11431,32 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The group operation could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10534,8 +11502,32 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupResourceWithSuccess' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The group operation could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10576,6 +11568,24 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupDeletedResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10638,6 +11648,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RoleListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10705,6 +11733,24 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupRoleAssignment' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10770,6 +11816,24 @@ paths: application/json: schema: $ref: '#/components/schemas/AssignedRoleDetails' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10826,6 +11890,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedRoleAssignmentResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -10891,10 +11973,34 @@ paths: application/json: schema: $ref: '#/components/schemas/UserListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: - group: administration + '502': + description: The upstream group service returned an invalid pagination cursor. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + x-oaiMeta: + group: administration examples: request: curl: | @@ -11016,6 +12122,24 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupMemberUser' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -11135,6 +12259,30 @@ paths: application/json: schema: $ref: '#/components/schemas/InviteListResponse' + '400': + description: The invite listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The invite specified by the after cursor was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11184,6 +12332,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Invite' + '400': + description: The invite request is invalid or the user has already joined or been invited. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11250,6 +12416,36 @@ paths: application/json: schema: $ref: '#/components/schemas/Invite' + '400': + description: The invite request is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The invite was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The invite could not be retrieved because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11371,6 +12567,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectListResponse' + '400': + description: The project listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project specified by the after cursor was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11418,6 +12638,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Project' + '400': + description: The project creation request is invalid or contains incompatible settings. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11461,6 +12699,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Project' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11513,6 +12769,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A requested project, user, service account, or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11573,6 +12847,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectApiKeyListResponse' + '400': + description: The listing parameters are invalid or the project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11638,6 +12936,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectApiKey' + '400': + description: The project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11704,6 +13026,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A requested project, user, service account, or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11741,6 +13081,30 @@ paths: application/json: schema: $ref: '#/components/schemas/Project' + '400': + description: The project is already archived or is the default project and cannot be archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11806,6 +13170,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ListProjectCertificatesResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -11868,8 +13244,32 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationProjectCertificateActivationResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A certificate was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The certificate update could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -11939,10 +13339,34 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationProjectCertificateDeactivationResponse' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: - group: administration + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A certificate was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + description: The certificate update could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + x-oaiMeta: + group: administration examples: request: curl: | @@ -12003,6 +13427,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectDataRetention' + '400': + description: The project ID is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The organization or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12045,6 +13487,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectDataRetention' + '400': + description: The requested data retention setting or transition is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The organization or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12109,6 +13569,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectGroupListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -12163,8 +13641,32 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectGroup' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The group operation could not be completed because of a server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12224,6 +13726,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectGroup' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -12271,6 +13791,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectGroupDeletedResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested group, user, or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -12309,6 +13847,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectHostedToolPermissions' + '400': + description: The project ID is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12364,6 +13926,36 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectHostedToolPermissions' + '400': + description: The hosted tool permission request is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The requested project setting conflicts with the organization policy. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12421,6 +14013,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectModelPermissions' + '400': + description: The project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or model permission settings were not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12467,6 +14083,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectModelPermissions' + '400': + description: The model permission request is invalid or the project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12511,6 +14151,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectModelPermissionsDeleteResponse' + '400': + description: The project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or model permission settings were not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12569,6 +14233,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectRateLimitListResponse' + '400': + description: The rate limit listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or pagination cursor was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12641,6 +14323,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12710,13 +14404,31 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - x-oaiMeta: - group: administration - examples: - request: - curl: | - curl https://api.openai.com/v1/organization/projects/proj_abc/service_accounts?after=custom_id&limit=20 \ - -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A requested project, user, service account, or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + x-oaiMeta: + group: administration + examples: + request: + curl: | + curl https://api.openai.com/v1/organization/projects/proj_abc/service_accounts?after=custom_id&limit=20 \ + -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -H "Content-Type: application/json" response: | { @@ -12769,6 +14481,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A requested project, user, service account, or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12824,6 +14554,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccount' + '400': + description: The project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or service account was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -12875,6 +14629,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectServiceAccount' + '400': + description: The service account update is invalid or the project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or service account was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13022,6 +14800,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendAlertListResource' + '400': + description: The spend alert listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or spend alert pagination cursor was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13080,6 +14876,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendAlert' + '400': + description: The spend alert request is invalid or conflicts with the hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13140,6 +14954,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendAlert' + '400': + description: The project ID is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or spend alert was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13196,6 +15028,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendAlert' + '400': + description: The spend alert update is invalid or conflicts with the hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or spend alert was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13255,6 +15105,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendAlertDeletedResource' + '400': + description: The project ID is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or spend alert was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13313,6 +15181,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A requested project, user, service account, or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13449,6 +15335,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectUser' + '400': + description: The project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or user was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13507,6 +15417,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A requested project, user, service account, or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13565,6 +15493,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: A requested project, user, service account, or API key was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13621,6 +15567,24 @@ paths: application/json: schema: $ref: '#/components/schemas/PublicRoleListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -13673,6 +15637,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Role' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -13727,15 +15709,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Role' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: - group: administration - examples: - request: - curl: | - curl https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01 \ - -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequests' + x-oaiMeta: + group: administration + examples: + request: + curl: | + curl https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01 \ + -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -H "Content-Type: application/json" response: | { @@ -13779,6 +15773,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Role' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -13832,6 +15844,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RoleDeletedResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -13895,6 +15925,24 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendAlertListResource' + '400': + description: The spend alert listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The spend alert specified by the after cursor was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -13946,6 +15994,18 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendAlert' + '400': + description: The spend alert request is invalid or conflicts with the hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' x-oaiMeta: group: administration examples: @@ -14000,6 +16060,18 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendAlert' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The spend alert was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -14050,6 +16122,24 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendAlert' + '400': + description: The spend alert update is invalid or conflicts with the hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The spend alert was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -14103,6 +16193,18 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendAlertDeletedResource' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The spend alert was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -14217,6 +16319,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -14351,6 +16465,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -14458,6 +16584,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -14597,6 +16735,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -14746,6 +16896,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -14880,6 +17042,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15041,6 +17215,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15177,6 +17363,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15284,6 +17482,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15427,6 +17637,18 @@ paths: application/json: schema: $ref: '#/components/schemas/UsageResponse' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15502,6 +17724,24 @@ paths: application/json: schema: $ref: '#/components/schemas/UserListResponse' + '400': + description: The user listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -15550,6 +17790,24 @@ paths: application/json: schema: $ref: '#/components/schemas/User' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The user was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -15596,23 +17854,47 @@ paths: application/json: schema: $ref: '#/components/schemas/User' - x-oaiMeta: - group: administration - examples: - request: - curl: | - curl -X POST https://api.openai.com/v1/organization/users/user_abc \ - -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ - -H "Content-Type: application/json" \ - -d '{ - "role": "owner" - }' - response: | - { - "object": "organization.user", - "id": "user_abc", - "name": "First Last", - "email": "user@example.com", + '400': + description: The requested user role is invalid or the update is not permitted. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The user was not found in this organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + x-oaiMeta: + group: administration + examples: + request: + curl: | + curl -X POST https://api.openai.com/v1/organization/users/user_abc \ + -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "role": "owner" + }' + response: | + { + "object": "organization.user", + "id": "user_abc", + "name": "First Last", + "email": "user@example.com", "role": "owner", "added_at": 1711471533 } @@ -15726,6 +18008,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RoleListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15793,6 +18093,24 @@ paths: application/json: schema: $ref: '#/components/schemas/UserRoleAssignment' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15859,6 +18177,24 @@ paths: application/json: schema: $ref: '#/components/schemas/AssignedRoleDetails' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15915,6 +18251,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedRoleAssignmentResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -15982,6 +18336,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RoleListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16055,6 +18427,24 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupRoleAssignment' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16126,6 +18516,24 @@ paths: application/json: schema: $ref: '#/components/schemas/AssignedRoleDetails' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16188,6 +18596,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedRoleAssignmentResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16251,6 +18677,24 @@ paths: application/json: schema: $ref: '#/components/schemas/PublicRoleListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16310,6 +18754,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Role' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16370,6 +18832,18 @@ paths: application/json: schema: $ref: '#/components/schemas/Role' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16428,6 +18902,24 @@ paths: application/json: schema: $ref: '#/components/schemas/Role' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16487,6 +18979,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RoleDeletedResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16555,6 +19065,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RoleListResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16628,20 +19156,38 @@ paths: application/json: schema: $ref: '#/components/schemas/UserRoleAssignment' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: - group: administration - examples: - request: - curl: | - curl -X POST https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles \ - -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ - -H "Content-Type: application/json" \ - -d '{ - "role_id": "role_01J1F8PROJ" - }' - response: | + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequests' + x-oaiMeta: + group: administration + examples: + request: + curl: | + curl -X POST https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles \ + -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "role_id": "role_01J1F8PROJ" + }' + response: | { "object": "user.role", "user": { @@ -16700,6 +19246,24 @@ paths: application/json: schema: $ref: '#/components/schemas/AssignedRoleDetails' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16762,6 +19326,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedRoleAssignmentResource' + '400': + description: The request parameters are invalid or the requested operation cannot be performed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The endpoint is unavailable or a requested resource was not found in this organization or project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -16880,6 +19462,24 @@ paths: responses: '200': description: Call accepted successfully. + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The session or call can no longer accept this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string x-oaiMeta: group: realtime-calls returns: |- @@ -16920,6 +19520,12 @@ paths: responses: '200': description: Call hangup initiated successfully. + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: realtime-calls returns: Returns `200 OK` when OpenAI begins terminating the realtime call. @@ -16955,6 +19561,18 @@ paths: responses: '200': description: Call referred successfully. + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string x-oaiMeta: group: realtime-calls returns: Returns `200 OK` once the REFER is handed off to your SIP provider. @@ -16994,6 +19612,24 @@ paths: responses: '200': description: Call rejected successfully. + '404': + description: The session or call was not found or is unavailable for this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The session or call can no longer accept this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: An internal error occurred. The response body is plain text. + content: + text/plain: + schema: + type: string x-oaiMeta: group: realtime-calls returns: Returns `200 OK` after OpenAI sends the SIP status code to the caller. @@ -17038,6 +19674,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RealtimeCreateClientSecretResponse' + '400': + description: Invalid session configuration or model. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The requested model was not found or is unavailable to this caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The requested model's availability could not be determined. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: realtime examples: @@ -17224,6 +19878,24 @@ paths: application/json: schema: $ref: '#/components/schemas/RealtimeTranslationClientSecretCreateResponse' + '400': + description: Invalid session configuration or model. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The requested model was not found or is unavailable to this caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The requested model's availability could not be determined. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: realtime examples: @@ -17304,6 +19976,18 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/ResponseStreamEvent' + '400': + description: Invalid response request or incompatible request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The requested model or a referenced resource was not found or is unavailable to this caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' '503': @@ -21822,6 +24506,12 @@ paths: $ref: '#/components/schemas/ListVectorStoresResponse' '429': $ref: '#/components/responses/TooManyRequests' + '503': + description: The vector store list is temporarily unavailable. Retry the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: vector_stores examples: @@ -21905,6 +24595,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' + '400': + description: The vector store input, files or chunking configuration are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: A referenced input file was not found or is not accessible. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -21976,6 +24678,12 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' + '404': + description: The vector store was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -22039,6 +24747,24 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' + '400': + description: The vector store input is invalid, the store has expired, or the store cannot be modified. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller is not authorized to update the vector store. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -22113,6 +24839,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteVectorStoreResponse' + '404': + description: The vector store was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The vector store is temporarily unavailable for this change or was modified concurrently. + headers: + Retry-After: + description: When this change is blocked by a vector store migration, the number of seconds to wait before retrying. Other conflicts may omit this header. + schema: + type: integer + minimum: 1 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -22180,8 +24924,38 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' + '400': + description: The file batch input is invalid, the store has expired, or a file limit would be exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The vector store is temporarily unavailable for this change or was modified concurrently. + headers: + Retry-After: + description: When this change is blocked by a vector store migration, the number of seconds to wait before retrying. Other conflicts may omit this header. + schema: + type: integer + minimum: 1 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The files could not be attached to the vector store. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: vector_stores examples: @@ -22301,6 +25075,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' + '400': + description: The file batch identifier is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store or file batch was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -22376,6 +25162,30 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' + '400': + description: The file batch identifier is invalid or the vector store has expired. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store or file batch was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The vector store is temporarily unavailable for this change or was modified concurrently. + headers: + Retry-After: + description: When this change is blocked by a vector store migration, the number of seconds to wait before retrying. Other conflicts may omit this header. + schema: + type: integer + minimum: 1 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -22492,6 +25302,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ListVectorStoreFilesResponse' + '400': + description: The file batch identifier or file filter is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store or file batch was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -22607,6 +25429,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ListVectorStoreFilesResponse' + '400': + description: The requested file filter is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -22687,8 +25521,38 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' + '400': + description: The file input is invalid, the store has expired, or a file limit would be exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The vector store is temporarily unavailable for this change or was modified concurrently. + headers: + Retry-After: + description: When this change is blocked by a vector store migration, the number of seconds to wait before retrying. Other conflicts may omit this header. + schema: + type: integer + minimum: 1 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The file could not be attached to the vector store. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: vector_stores examples: @@ -22764,8 +25628,20 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' + '404': + description: The vector store or file was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The vector store file could not be retrieved. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: vector_stores examples: @@ -22832,8 +25708,38 @@ paths: application/json: schema: $ref: '#/components/schemas/DeleteVectorStoreFileResponse' + '400': + description: The vector store has expired. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store or file was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The vector store is temporarily unavailable for this change or was modified concurrently. + headers: + Retry-After: + description: When this change is blocked by a vector store migration, the number of seconds to wait before retrying. Other conflicts may omit this header. + schema: + type: integer + minimum: 1 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The vector store file could not be deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: vector_stores examples: @@ -22906,8 +25812,38 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' + '400': + description: The file attributes are invalid or the vector store has expired. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store or file was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The vector store is temporarily unavailable for this change or was modified concurrently. + headers: + Retry-After: + description: When this change is blocked by a vector store migration, the number of seconds to wait before retrying. Other conflicts may omit this header. + schema: + type: integer + minimum: 1 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The vector store file attributes could not be updated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: vector_stores examples: @@ -22958,8 +25894,26 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileContentResponse' + '400': + description: The vector store has expired or the file content is not ready. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store or file was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The vector store file content could not be retrieved. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: vector_stores examples: @@ -23006,6 +25960,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreSearchResultsPage' + '400': + description: The search input or filters are invalid, or the vector store has expired. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The vector store was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -23077,8 +26043,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationResource' + '400': + description: The conversation input is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The conversation update could not be finalized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: conversations path: create @@ -23176,6 +26154,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationResource' + '404': + description: The conversation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -23236,6 +26220,12 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedConversationResource' + '404': + description: The conversation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -23300,8 +26290,26 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationResource' + '400': + description: The conversation metadata is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The conversation was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The conversation update could not be finalized. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: conversations path: update @@ -23380,6 +26388,32 @@ paths: application/json: schema: $ref: '#/components/schemas/SafetyCaseResource' + '400': + description: The safety case ID is too long. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The safety case was not found or is not accessible to the caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + description: The safety case lookup failed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '503': + description: The safety case lookup is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: safety-cases path: retrieve @@ -23418,6 +26452,26 @@ paths: application/json: schema: $ref: '#/components/schemas/SafetyAlertResource' + '400': + description: The safety alert ID is too long. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The safety alert was not found or is not accessible to the caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequests' + '503': + description: The safety alert lookup is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: safety-alerts path: retrieve @@ -23463,6 +26517,38 @@ paths: description: The Live session recording as a stereo WAV file, with input audio in the left channel and output audio in the right channel. type: string format: binary + '400': + description: Invalid Live session ID. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The endpoint is unavailable or the stored session recording was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + $ref: '#/components/responses/TooManyRequests' + '500': + description: The stored session audio could not be exported. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '503': + description: The audio export is temporarily unavailable. + headers: + Retry-After: + description: The minimum number of seconds to wait before retrying. + schema: + type: integer + minimum: 1 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: live returns: The stored session recording as binary stereo WAV audio. @@ -23508,6 +26594,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ExternalStorageListResource' + '400': + description: The organization is not enabled for external storage or the listing parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The organization or project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23595,6 +26699,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ExternalStorageResponse' + '400': + description: The external storage request is invalid or the organization or project does not support it. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The organization, project, or external storage was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '503': + description: External storage registration is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23719,6 +26847,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ExternalStorageResponse' + '400': + description: The organization is not enabled for external storage. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The organization or external storage was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23765,6 +26911,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ExternalStorageDeletedResource' + '400': + description: The organization is not enabled for external storage. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The organization or external storage was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23800,6 +26964,30 @@ paths: application/json: schema: $ref: '#/components/schemas/ExternalStorageResponse' + '400': + description: The external storage configuration is invalid or the organization or project does not support it. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The organization, project, or external storage was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '503': + description: External storage validation is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23841,6 +27029,18 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendLimitResource' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The organization does not have a hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23880,6 +27080,18 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendLimitResource' + '400': + description: The requested spend limit is invalid or cannot be applied. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' x-oaiMeta: group: administration examples: @@ -23917,6 +27129,18 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationSpendLimitDeletedResource' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The organization does not have a hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23952,6 +27176,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendLimitResource' + '400': + description: The project ID is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found or does not have a hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -23991,6 +27233,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendLimitDeletedResource' + '400': + description: The project ID is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found or does not have a hard spend limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -24032,6 +27292,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectSpendLimitResource' + '400': + description: The requested spend limit is invalid or cannot be applied. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -24090,6 +27368,36 @@ paths: application/json: schema: $ref: '#/components/schemas/ServiceAccountApiKeyBody' + '400': + description: The API key request is invalid or the project is archived. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: The caller does not have permission to perform this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/PermissionErrorResponse' + '404': + description: The project or service account was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: The service account already has an API key and cannot create another. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: Too many management requests. Reduce the request rate and try again later. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -24132,9 +27440,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProvenanceResource' + $ref: '#/components/schemas/ProvenanceResource' + '400': + description: The file is missing, invalid, unsupported, too large, or rejected by safety checks. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Content provenance checks are unavailable to this caller. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The content provenance check could not be completed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '503': + description: Content provenance inspection is temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: content_provenance_checks /videos: @@ -24157,8 +27489,26 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoResource' + '400': + description: The video request is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: A referenced character was not found or is not accessible, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The video generation task could not be created. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' deprecated: true @@ -24283,6 +27633,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoListResource' + '400': + description: The query parameters are invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The video specified by after was not found or is not accessible, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' deprecated: true x-oaiMeta: group: videos @@ -24385,6 +27747,30 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoCharacterResource' + '400': + description: The character request or video upload is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The video character endpoint is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The character could not be created. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '504': + description: The character creation request timed out. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' deprecated: true /videos/characters/{character_id}: get: @@ -24408,6 +27794,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoCharacterResource' + '400': + description: The character ID is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The character was not found or is not accessible, or the video character endpoint is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' deprecated: true /videos/edits: post: @@ -24429,8 +27827,26 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoResource' + '400': + description: The edit request or source video is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The source video or a referenced character was not found or is not accessible, the source video is not ready, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The source video media is unavailable or the edit task could not be created. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' deprecated: true @@ -24454,8 +27870,26 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoResource' + '400': + description: The extension request or source video is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The source video was not found or is not accessible, the source video is not ready, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The source video media is unavailable or the extension task could not be created. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' deprecated: true @@ -24481,6 +27915,18 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoResource' + '400': + description: The request is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The video was not found or is not accessible, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' deprecated: true x-oaiMeta: group: videos @@ -24568,6 +28014,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedVideoResource' + '400': + description: The video is still being processed, the request is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The video was not found or is not accessible, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The video or its stored media could not be deleted. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' deprecated: true x-oaiMeta: group: videos @@ -24673,6 +28137,24 @@ paths: application/json: schema: type: string + '400': + description: The request or content variant is invalid, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The video was not found or is not ready, its download is unavailable or expired, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The requested video media is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' deprecated: true x-oaiMeta: group: videos @@ -24780,8 +28262,26 @@ paths: application/json: schema: $ref: '#/components/schemas/VideoResource' + '400': + description: The request or source video is not supported for remixing, or the organization does not support video generation. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The source video or a referenced character was not found or is not accessible, the source video is not ready, or the Videos API is unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The source generation is unavailable or the remix task could not be created. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' deprecated: true @@ -24902,6 +28402,12 @@ paths: application/json: schema: $ref: '#/components/schemas/TokenCountsResource' + '400': + description: The request to count input tokens is invalid or contains incompatible parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: @@ -25017,6 +28523,12 @@ paths: application/json: schema: $ref: '#/components/schemas/CompactResource' + '400': + description: Invalid compaction request or incompatible input parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' '503': @@ -25176,8 +28688,20 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillResource' + '400': + description: The uploaded skill files or archive are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The skill could not be saved. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' get: tags: - Skills @@ -25213,6 +28737,12 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillListResource' + '404': + description: The skill specified by `after` was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' /skills/{skill_id}: @@ -25237,6 +28767,12 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedSkillResource' + '404': + description: The skill was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' get: @@ -25260,6 +28796,12 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillResource' + '404': + description: The skill was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' post: @@ -25288,6 +28830,18 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillResource' + '400': + description: The requested version is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The skill or requested skill version was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' /skills/{skill_id}/content: @@ -25316,6 +28870,12 @@ paths: application/json: schema: type: string + '404': + description: The skill was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' /skills/{skill_id}/versions: @@ -25348,8 +28908,26 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersionResource' + '400': + description: The uploaded skill files or archive are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The skill was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' + '500': + description: The skill version could not be saved. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' get: tags: - Skills @@ -25392,6 +28970,18 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersionListResource' + '400': + description: The version specified by `after` does not belong to this skill. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The skill or the version specified by `after` was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' /skills/{skill_id}/versions/{version}: @@ -25423,6 +29013,18 @@ paths: application/json: schema: $ref: '#/components/schemas/SkillVersionResource' + '400': + description: The requested version is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The skill or requested skill version was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' delete: @@ -25453,6 +29055,18 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedSkillVersionResource' + '400': + description: The requested version is invalid, or it is the default version and other versions remain. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The skill or requested skill version was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' /skills/{skill_id}/versions/{version}/content: @@ -25487,7 +29101,19 @@ paths: format: binary application/json: schema: - type: string + type: string + '400': + description: The requested version is invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The skill or requested skill version was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' /chatkit/sessions/{session_id}/cancel: @@ -25513,6 +29139,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ChatSessionResource' + '400': + description: The request is invalid or the required ChatKit beta header is missing or invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The session was not found or is not accessible. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The request rate limit has been exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: chatkit beta: true @@ -25618,6 +29262,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ChatSessionResource' + '400': + description: The request is invalid or the required ChatKit beta header is missing or invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The requested workflow or workflow version was not found or is not accessible. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The request rate limit has been exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: chatkit beta: true @@ -25781,6 +29443,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ThreadItemListResource' + '400': + description: The request is invalid or the required ChatKit beta header is missing or invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The thread was not found or is not accessible. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The request rate limit has been exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: chatkit beta: true @@ -25909,6 +29589,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ThreadResource' + '400': + description: The request is invalid or the required ChatKit beta header is missing or invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The thread was not found or is not accessible. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The request rate limit has been exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: chatkit beta: true @@ -26031,6 +29729,24 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedThreadResource' + '400': + description: The request is invalid or the required ChatKit beta header is missing or invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The thread was not found or is not accessible. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The request rate limit has been exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true examples: @@ -26147,6 +29863,24 @@ paths: application/json: schema: $ref: '#/components/schemas/ThreadListResource' + '400': + description: The request is invalid or the required ChatKit beta header is missing or invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The thread specified by after was not found or is not accessible. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '429': + description: The request rate limit has been exceeded. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: chatkit beta: true @@ -26270,6 +30004,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -26364,6 +30104,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -26427,6 +30173,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -27089,6 +30841,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -27143,6 +30901,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -27202,6 +30966,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -27265,6 +31035,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -27323,6 +31099,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -28639,6 +32421,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -28706,6 +32494,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse-2' + '403': + description: The API key lacks the required permission. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse-2' '404': description: The requested session or event was not found. content: @@ -29426,6 +33220,18 @@ paths: application/json: schema: $ref: '#/components/schemas/WebhookEndpointListResource' + '400': + description: The request parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The pagination cursor does not identify a webhook endpoint in the authenticated project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true post: @@ -29445,6 +33251,12 @@ paths: application/json: schema: $ref: '#/components/schemas/WebhookEndpointWithSecretResource' + '400': + description: The webhook endpoint parameters are invalid or the endpoint cannot be created with the requested URL or event types. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true /webhook_endpoints/{webhook_endpoint_id}: @@ -29467,6 +33279,18 @@ paths: application/json: schema: $ref: '#/components/schemas/WebhookEndpointBody' + '400': + description: The request parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The webhook endpoint was not found in the authenticated project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true post: @@ -29493,6 +33317,18 @@ paths: application/json: schema: $ref: '#/components/schemas/WebhookEndpointBody' + '400': + description: The webhook endpoint parameters are invalid or the requested URL or event types are not permitted. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The webhook endpoint was not found in the authenticated project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true delete: @@ -29514,6 +33350,18 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedWebhookEndpointResource' + '400': + description: The request parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The webhook endpoint was not found in the authenticated project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true /webhook_endpoints/{webhook_endpoint_id}/rotate_secret: @@ -29541,6 +33389,18 @@ paths: application/json: schema: $ref: '#/components/schemas/WebhookEndpointWithSecretResource' + '400': + description: The request parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The webhook endpoint was not found in the authenticated project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true /webhook_endpoints/{webhook_endpoint_id}/test: @@ -29568,6 +33428,24 @@ paths: application/json: schema: $ref: '#/components/schemas/WebhookEndpointTestResultResource' + '400': + description: The request parameters are invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: The webhook endpoint was not found in the authenticated project. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: The sample event could not be sent to the webhook endpoint. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true /webhook_event_types: @@ -29583,6 +33461,18 @@ paths: application/json: schema: $ref: '#/components/schemas/WebhookEventTypeListResource' + '401': + description: The request does not contain authentication credentials. + headers: + WWW-Authenticate: + description: The bearer authentication challenge returned by the service. + schema: + type: string + example: Bearer realm="OpenAI API" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: beta: true /responses?beta=true: @@ -29615,6 +33505,18 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/BetaResponseStreamEvent' + '400': + description: Invalid response request or incompatible request parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/BetaErrorResponse' + '404': + description: The requested model or a referenced resource was not found or is unavailable to this caller. + content: + application/json: + schema: + $ref: '#/components/schemas/BetaErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' '503': @@ -31196,6 +35098,12 @@ paths: application/json: schema: $ref: '#/components/schemas/BetaCompactResource' + '400': + description: Invalid compaction request or incompatible input parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/BetaErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' '503': @@ -31485,6 +35393,12 @@ paths: application/json: schema: $ref: '#/components/schemas/BetaTokenCountsResource' + '400': + description: The request to count input tokens is invalid or contains incompatible parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/BetaErrorResponse' '429': $ref: '#/components/responses/TooManyRequests' x-oaiMeta: