From dcec5b136841a9735f574c3854258b0fa91176c1 Mon Sep 17 00:00:00 2001 From: markstuart-oai <323302876+markstuart-oai@users.noreply.github.com> Date: Fri, 25 Sep 2026 20:55:00 +0000 Subject: [PATCH] chore(api): clarify documented API error responses Castiron-Internal-PR: https://github.com/openai/openai-python-internal/pull/161 Castiron-Source-SHA: d7da583237a5ded5d7aeb2a38b6855a1e359bfd6 Castiron-Public-Base-SHA: 5d4003c12d5df5a5faed35971cac3bcb711fdf7d --- .castiron.stats.yml | 10 +- api_reference/openapi.transformed.yml | 4195 ++++++++++++++++++++++++- 2 files changed, 4115 insertions(+), 90 deletions(-) diff --git a/.castiron.stats.yml b/.castiron.stats.yml index c1bf184a5a..cbf8b0fb52 100644 --- a/.castiron.stats.yml +++ b/.castiron.stats.yml @@ -1,8 +1,8 @@ schema_version: 1 -generation_id: 1dd246ed-238d-481d-9649-a93ac4e0d455 -openapi_spec_hash: 91cc2e79b522ef1d5b1d0a7c930b06b2 -openapi_transformed_spec_hash: b081b94fc815ee91ad978e592e233b83 +generation_id: 8f7e098f-e353-41cb-b58d-e4f29fe93695 +openapi_spec_hash: 040cdc82e15feee4aff18579e53dbaa4 +openapi_transformed_spec_hash: 122a138e15209cbe9b31f91cdaccd592 config_hash: 84cdcc959ee7140cc9a65e9b642c097b -codegen_sha: de6e1f3fdc3337dd65e009deee8a0e6654912a82 +codegen_sha: ad8ea5ac6f75d45952618ec57d96ba0285961aee codegen_hash: 67b5ab20d81c80689a8a857466838278fb0d428d48b3261d2479bab43396d589 -public_codegen_sha: ee717eb8a6c8891cc8d8bd1f5af1471d3806b213 +public_codegen_sha: 7c66cc09bbb86486567a7cee32f3048ebb85175e diff --git a/api_reference/openapi.transformed.yml b/api_reference/openapi.transformed.yml index 7f6cec4af7..c2e045786d 100644 --- a/api_reference/openapi.transformed.yml +++ b/api_reference/openapi.transformed.yml @@ -604,8 +604,37 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/CreateSpeechResponseStreamEvent' + '400': + description: Invalid speech request, input, output format, or voice. + 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 voice or speech audio could not be processed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -718,8 +747,49 @@ paths: text/event-stream: schema: $ref: '#/components/schemas/CreateTranscriptionResponseStreamEvent' + '400': + description: Invalid audio 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. + '413': + description: The audio request exceeds the supported size limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The audio could not be processed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '502': + description: The upstream audio service connection failed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -1271,8 +1341,49 @@ paths: - $ref: '#/components/schemas/CreateTranslationResponseVerboseJson' x-stainless-skip: - go + '400': + description: Invalid audio 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. + '413': + description: The audio request exceeds the supported size limit. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/InferenceRateLimited' + '500': + description: The audio could not be processed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '502': + description: The upstream audio service connection failed. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' '503': $ref: '#/components/responses/InferenceServiceUnavailable' x-oaiMeta: @@ -1348,6 +1459,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: @@ -1388,6 +1511,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: @@ -1416,6 +1551,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: @@ -1449,6 +1596,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: @@ -1481,6 +1640,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: @@ -1509,6 +1680,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: @@ -2110,8 +2299,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: @@ -3298,8 +3522,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: @@ -3466,6 +3725,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: @@ -3515,6 +3780,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: @@ -3581,6 +3852,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: @@ -3619,6 +3896,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: @@ -3665,6 +3948,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: @@ -3727,6 +4022,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: @@ -3778,6 +4079,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: @@ -3816,6 +4123,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: @@ -3851,6 +4164,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: @@ -3910,15 +4229,33 @@ paths: application/json: schema: $ref: '#/components/schemas/ConversationItemList' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: - group: conversations - path: create-item - examples: - request: - curl: | - curl https://api.openai.com/v1/conversations/conv_123/items \ + '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 + examples: + request: + curl: | + curl https://api.openai.com/v1/conversations/conv_123/items \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ @@ -4106,6 +4443,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: @@ -4198,6 +4547,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: @@ -4274,8 +4629,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 @@ -4339,8 +4712,37 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateEmbeddingResponse' + '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: @@ -4589,6 +4991,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: @@ -4770,6 +5178,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: @@ -4872,6 +5286,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: @@ -4986,12 +5412,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: @@ -5078,6 +5510,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: @@ -5214,9 +5658,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: @@ -5398,6 +5854,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: @@ -5811,12 +6279,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: @@ -5916,6 +6390,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: @@ -6050,6 +6536,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: @@ -8188,8 +8686,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: @@ -8365,8 +8887,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: @@ -8503,6 +9049,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: @@ -8587,31 +9177,70 @@ paths: transport: type: webrtc sdp: - x-oaiMeta: - group: live - returns: Returns 201 Created with the session identifier in session.id and SDP answer in transport.sdp. - examples: - request: - curl: |- - curl https://api.openai.com/v1/live/sessions \ - -H "Authorization: Bearer $OPENAI_API_KEY" \ - -H "Content-Type: application/json" \ - -d '{"session":{"model":"gpt-live-1","instructions":"Be concise. Ask for clarification when needed."},"transport":{"type":"webrtc","sdp":""}}' - /live/sessions/{session_id}/accept: - post: - operationId: accept-live-session - summary: Accept call - description: Accept an incoming SIP call. Supply session with type live, the model, and startup configuration. Before accepting calls, follow the [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting) to write frontend conversation instructions and a separate backend prompt. SIP media format is negotiated; omit audio.format. - tags: - - Live - parameters: - - in: path - name: session_id - required: true - description: Opaque Live session identifier from the creation response or incoming-call webhook. Preserve the returned value unchanged, including its prefix. - schema: - type: string - requestBody: + '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. + examples: + request: + curl: |- + curl https://api.openai.com/v1/live/sessions \ + -H "Authorization: Bearer $OPENAI_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{"session":{"model":"gpt-live-1","instructions":"Be concise. Ask for clarification when needed."},"transport":{"type":"webrtc","sdp":""}}' + /live/sessions/{session_id}/accept: + post: + operationId: accept-live-session + summary: Accept call + description: Accept an incoming SIP call. Supply session with type live, the model, and startup configuration. Before accepting calls, follow the [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting) to write frontend conversation instructions and a separate backend prompt. SIP media format is negotiated; omit audio.format. + tags: + - Live + parameters: + - in: path + name: session_id + required: true + description: Opaque Live session identifier from the creation response or incoming-call webhook. Preserve the returned value unchanged, including its prefix. + schema: + type: string + requestBody: required: true content: application/json: @@ -8620,6 +9249,42 @@ paths: responses: '200': description: Session accept 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' + '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. @@ -8650,6 +9315,42 @@ paths: 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. @@ -8677,6 +9378,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. @@ -8703,6 +9410,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. @@ -8729,6 +9454,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. @@ -8982,8 +9731,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: @@ -9248,6 +10015,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: @@ -9313,6 +10092,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: @@ -9365,6 +10162,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: @@ -9427,6 +10236,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: @@ -9544,6 +10365,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: @@ -9656,6 +10489,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: @@ -9710,6 +10555,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: @@ -9761,11 +10618,35 @@ 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' - x-oaiMeta: - group: administration - examples: + '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: | curl https://api.openai.com/v1/organization/certificates/activate \ @@ -9828,8 +10709,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: @@ -9905,6 +10810,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: @@ -9956,8 +10879,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: @@ -10005,6 +10952,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: @@ -10106,6 +11071,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: @@ -10159,6 +11136,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: @@ -10194,6 +11183,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: @@ -10254,6 +11261,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: @@ -10301,8 +11326,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: @@ -10345,8 +11400,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: @@ -10392,8 +11471,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: @@ -10434,6 +11537,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: @@ -10496,6 +11617,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: @@ -10563,6 +11702,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: @@ -10628,6 +11785,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: @@ -10684,10 +11859,28 @@ paths: application/json: schema: $ref: '#/components/schemas/DeletedRoleAssignmentResource' - '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: 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: | @@ -10749,8 +11942,32 @@ 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' + '502': + description: The upstream group service returned an invalid pagination cursor. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' x-oaiMeta: group: administration examples: @@ -10874,6 +12091,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: @@ -10993,6 +12228,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: @@ -11042,6 +12301,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: @@ -11108,6 +12385,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: @@ -11229,6 +12536,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: @@ -11276,6 +12607,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: @@ -11319,6 +12668,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: @@ -11371,6 +12738,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: @@ -11431,6 +12816,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: @@ -11496,6 +12905,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: @@ -11562,6 +12995,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: @@ -11599,6 +13050,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: @@ -11664,9 +13139,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ListProjectCertificatesResponse' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: + '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: group: administration examples: request: @@ -11726,8 +13213,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: @@ -11797,8 +13308,32 @@ paths: application/json: schema: $ref: '#/components/schemas/OrganizationProjectCertificateDeactivationResponse' + '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: @@ -11861,6 +13396,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: @@ -11903,6 +13456,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: @@ -11967,6 +13538,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: @@ -12021,8 +13610,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: @@ -12082,6 +13695,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: @@ -12129,6 +13760,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: @@ -12167,6 +13816,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: @@ -12222,6 +13895,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: @@ -12279,6 +13982,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: @@ -12325,6 +14052,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: @@ -12369,6 +14120,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: @@ -12427,9 +14202,27 @@ paths: application/json: schema: $ref: '#/components/schemas/ProjectRateLimitListResponse' - x-oaiMeta: - group: administration - examples: + '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: request: curl: | curl https://api.openai.com/v1/organization/projects/proj_abc/rate_limits?after=rl_xxx&limit=20 \ @@ -12499,6 +14292,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: @@ -12568,6 +14373,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: @@ -12627,6 +14450,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: @@ -12682,6 +14523,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: @@ -12733,6 +14598,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: @@ -12880,6 +14769,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: @@ -12938,6 +14845,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: @@ -12998,6 +14923,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: @@ -13054,6 +14997,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: @@ -13113,6 +15074,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: @@ -13171,6 +15150,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: @@ -13307,6 +15304,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: @@ -13365,6 +15386,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: @@ -13423,6 +15462,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: @@ -13479,6 +15536,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: @@ -13531,9 +15606,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Role' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: + '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: @@ -13585,6 +15678,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: @@ -13637,6 +15742,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: @@ -13690,6 +15813,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: @@ -13753,6 +15894,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: @@ -13804,6 +15963,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: @@ -13858,6 +16029,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: @@ -13908,6 +16091,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: @@ -13961,6 +16162,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: @@ -14075,6 +16288,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: @@ -14209,6 +16434,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: @@ -14316,6 +16553,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: @@ -14455,6 +16704,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: @@ -14604,6 +16865,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: @@ -14738,6 +17011,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: @@ -14899,6 +17184,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: @@ -15035,6 +17332,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: @@ -15142,6 +17451,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: @@ -15285,6 +17606,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: @@ -15360,6 +17693,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: @@ -15408,6 +17759,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: @@ -15454,14 +17823,38 @@ 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" \ + '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" }' @@ -15584,6 +17977,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: @@ -15651,6 +18062,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: @@ -15717,6 +18146,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: @@ -15773,6 +18220,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: @@ -15840,6 +18305,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: @@ -15913,6 +18396,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: @@ -15984,6 +18485,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: @@ -16046,6 +18565,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: @@ -16109,6 +18646,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: @@ -16168,6 +18723,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: @@ -16228,6 +18801,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: @@ -16286,6 +18871,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: @@ -16345,6 +18948,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: @@ -16413,6 +19034,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: @@ -16486,6 +19125,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: @@ -16558,14 +19215,32 @@ paths: application/json: schema: $ref: '#/components/schemas/AssignedRoleDetails' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: - group: administration - examples: - request: - curl: | - curl https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles/role_01J1F8PROJ \ + '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 https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles/role_01J1F8PROJ \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -H "Content-Type: application/json" response: | @@ -16620,6 +19295,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: @@ -16738,6 +19431,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: |- @@ -16778,6 +19489,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. @@ -16813,6 +19530,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. @@ -16852,6 +19581,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. @@ -16896,6 +19643,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: @@ -17082,6 +19847,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: @@ -17162,6 +19945,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': @@ -21680,6 +24475,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: @@ -21763,6 +24564,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: @@ -21834,6 +24647,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: @@ -21897,6 +24716,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: @@ -21971,6 +24808,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: @@ -22038,8 +24893,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: @@ -22159,6 +25044,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: @@ -22234,6 +25131,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: @@ -22350,6 +25271,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: @@ -22465,6 +25398,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: @@ -22545,20 +25490,50 @@ paths: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' - '429': - $ref: '#/components/responses/TooManyRequests' - x-oaiMeta: - group: vector_stores - examples: - request: - curl: | - curl https://api.openai.com/v1/vector_stores/vs_abc123/files \ - -H "Authorization: Bearer $OPENAI_API_KEY" \ - -H "Content-Type: application/json" \ - -H "OpenAI-Beta: assistants=v2" \ - -d '{ - "file_id": "file-abc123" - }' + '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: + request: + curl: | + curl https://api.openai.com/v1/vector_stores/vs_abc123/files \ + -H "Authorization: Bearer $OPENAI_API_KEY" \ + -H "Content-Type: application/json" \ + -H "OpenAI-Beta: assistants=v2" \ + -d '{ + "file_id": "file-abc123" + }' python: | from openai import OpenAI client = OpenAI() @@ -22622,8 +25597,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: @@ -22690,8 +25677,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: @@ -22764,8 +25781,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: @@ -22816,8 +25863,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: @@ -22864,6 +25929,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: @@ -22935,8 +26012,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 @@ -23034,6 +26123,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: @@ -23094,6 +26189,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: @@ -23158,8 +26259,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 @@ -23238,6 +26357,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 @@ -23276,6 +26421,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 @@ -23321,6 +26486,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. @@ -23366,6 +26563,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: @@ -23436,6 +26651,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: @@ -23526,6 +26765,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: @@ -23572,6 +26829,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: @@ -23607,6 +26882,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: @@ -23648,6 +26947,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: @@ -23687,6 +26998,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: @@ -23724,6 +27047,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: @@ -23759,6 +27094,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: @@ -23798,6 +27151,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: @@ -23839,6 +27210,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: @@ -23897,6 +27286,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: @@ -23939,9 +27358,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: @@ -23964,8 +27407,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 @@ -24090,6 +27551,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 @@ -24192,6 +27665,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: @@ -24215,6 +27712,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: @@ -24236,8 +27745,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 @@ -24261,8 +27788,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 @@ -24288,6 +27833,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 @@ -24375,6 +27932,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 @@ -24480,6 +28055,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 @@ -24587,8 +28180,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 @@ -24709,6 +28320,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: @@ -24824,6 +28441,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': @@ -24983,8 +28606,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 @@ -25020,6 +28655,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}: @@ -25044,6 +28685,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: @@ -25067,6 +28714,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: @@ -25095,6 +28748,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: @@ -25123,6 +28788,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: @@ -25155,8 +28826,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 @@ -25199,6 +28888,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}: @@ -25230,6 +28931,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: @@ -25260,6 +28973,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: @@ -25294,7 +29019,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: @@ -25320,6 +29057,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 @@ -25425,6 +29180,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 @@ -25588,6 +29361,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 @@ -25716,6 +29507,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 @@ -25838,6 +29647,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: @@ -25954,6 +29781,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 @@ -26077,6 +29922,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: @@ -26171,6 +30022,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: @@ -26234,6 +30091,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: @@ -26896,6 +30759,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: @@ -26950,6 +30819,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: @@ -27009,6 +30884,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: @@ -27072,6 +30953,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: @@ -27130,6 +31017,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: @@ -28446,6 +32339,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: @@ -28513,6 +32412,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: @@ -29233,6 +33138,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: @@ -29252,6 +33169,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}: @@ -29274,6 +33197,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: @@ -29300,6 +33235,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: @@ -29321,6 +33268,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: @@ -29348,6 +33307,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: @@ -29375,6 +33346,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: @@ -29390,6 +33379,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: @@ -29422,6 +33423,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': @@ -31003,6 +35016,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': @@ -31292,6 +35311,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: