Python 88.3%
TypeScript 7.6%
Shell 4.1%
1# OpenAI API reference — full documentation23> Single-file Markdown export of API reference docs and endpoint pages.45Curated index: https://developers.openai.com/api/reference/llms.txt67# Administration Overview89Use the Administration API to manage organization resources such as users, invites, projects, API keys, and audit logs.10To access these endpoints, [create an Admin API key](https://platform.openai.com/settings/organization/admin-keys). Admin API keys cannot be used for non-administration endpoints.1112Related guides:1314- [Best practices in setting up your organization](https://developers.openai.com/api/docs/guides/production-best-practices#setting-up-your-organization)15- [Using the Admin APIs](https://developers.openai.com/api/docs/guides/admin-apis).1617---1819# Chat Completions Overview2021The Chat Completions API endpoint will generate a model response from a22list of messages comprising a conversation.2324Related guides:2526- [Quickstart](https://developers.openai.com/docs/quickstart?api-mode=chat)27- [Text inputs and outputs](https://developers.openai.com/docs/guides/text?api-mode=chat)28- [Image inputs](https://developers.openai.com/docs/guides/images?api-mode=chat)29- [Audio inputs and outputs](https://developers.openai.com/docs/guides/audio?api-mode=chat)30- [Structured Outputs](https://developers.openai.com/docs/guides/structured-outputs?api-mode=chat)31- [Function calling](https://developers.openai.com/docs/guides/function-calling?api-mode=chat)32- [Conversation state](https://developers.openai.com/docs/guides/conversation-state?api-mode=chat)3334**Starting a new project?** We recommend trying [Responses](https://developers.openai.com/docs/api-reference/responses)35to take advantage of the latest OpenAI platform features. Compare36[Chat Completions with Responses](https://developers.openai.com/docs/guides/responses-vs-chat-completions?api-mode=responses).3738---3940# API Overview4142Use this reference to look up OpenAI API endpoints, request and response43schemas, streaming events, client library methods, and shared behavior such as44authentication, errors, rate limits, and request IDs.4546## Start here47481. Choose the API surface for your application:49 - [Responses](https://developers.openai.com/api/reference/responses/overview) for direct model requests, tool use, audio, image, and text inputs, and stateful interactions.50 - [Realtime API](https://developers.openai.com/api/docs/guides/realtime) for low-latency voice or audio sessions over WebRTC, WebSocket, or SIP. Use the [client events](https://developers.openai.com/api/reference/resources/realtime/client-events) and [server events](https://developers.openai.com/api/reference/resources/realtime/server-events) references while building sessions.51 - [Administration](https://developers.openai.com/api/reference/administration/overview) for organization workflows such as users, invites, projects, API keys, and audit logs.522. Create credentials. Use a standard [API key](https://platform.openai.com/settings/organization/api-keys) for application requests, an [Admin API key](https://platform.openai.com/settings/organization/admin-keys) for Administration endpoints, or [workload identity federation](https://developers.openai.com/api/docs/guides/workload-identity-federation) for short-lived access tokens.533. Install an official client library from the [libraries page](https://developers.openai.com/api/docs/libraries), or call the HTTP API directly from any environment that supports HTTP requests.544. Make a first request with the [developer quickstart](https://developers.openai.com/api/docs/quickstart) or go straight to the [Responses create reference](https://developers.openai.com/api/reference/resources/responses/methods/create).555. Before production, review [error codes](https://developers.openai.com/api/docs/guides/error-codes), [rate limits](https://developers.openai.com/api/docs/guides/rate-limits), and request ID logging below.5657## Authentication5859The OpenAI API accepts bearer credentials from API keys or from short-lived access tokens created with [workload identity federation](https://developers.openai.com/api/docs/guides/workload-identity-federation).6061**Remember that your API key is a secret.** Don't share it with others or expose it in any client-side code such as browsers or apps. Load API keys from an environment variable or key management service on the server.6263Revocations of an API key take effect within a few seconds. Most updates that64 affect authentication results of an API key propagate within 15 minutes, but65 can potentially take longer.6667Provide API credentials with [HTTP Bearer authentication](https://swagger.io/docs/specification/v3_0/authentication/bearer-authentication/).6869```bash70Authorization: Bearer OPENAI_API_KEY_OR_ACCESS_TOKEN71```7273If you belong to more than one organization or access projects through a legacy user API key, pass a header to specify which organization and project to use for an API request:7475```bash76curl https://api.openai.com/v1/models \77 -H "Authorization: Bearer $OPENAI_API_KEY" \78 -H "OpenAI-Organization: $ORGANIZATION_ID" \79 -H "OpenAI-Project: $PROJECT_ID"80```8182Usage from these API requests counts as usage for the specified organization and project. Find organization and project IDs in your [dashboard settings](https://platform.openai.com/settings/organization/general).8384## Request headers8586For reliable behavior across API paths and HTTP versions, keep the total size87of an API request's headers under 64 KiB. This budget includes the names and88values of all headers, including common headers such as `Authorization`,89`Content-Type`, and `User-Agent`, as well as any custom headers.9091To leave room for required headers and headers added by intermediaries, keep92any individual custom header value and the total size of all custom header93values at 60 KiB or less. Requests with larger headers may fail before they94reach the API, so you may not receive a response or an `x-request-id`.9596## Debugging requests9798[Error codes](https://developers.openai.com/api/docs/guides/error-codes) describe failures returned from API responses. Inspect HTTP response headers for the unique ID of a request and rate limit details. Common response headers include:99100**API meta information**101102- `openai-organization`: The [organization](https://developers.openai.com/api/docs/guides/production-best-practices#setting-up-your-organization) associated with the request103- `openai-processing-ms`: Time taken processing your API request104- `openai-version`: REST API version used for this request (currently `2020-10-01`)105- `x-request-id`: Unique identifier for this API request (used in troubleshooting)106107**[Rate limiting information](https://developers.openai.com/api/docs/guides/rate-limits)**108109- `x-ratelimit-limit-requests`110- `x-ratelimit-limit-tokens`111- `x-ratelimit-remaining-requests`112- `x-ratelimit-remaining-tokens`113- `x-ratelimit-reset-requests`114- `x-ratelimit-reset-tokens`115- `x-ratelimit-limit-project-tokens`116- `x-ratelimit-remaining-project-tokens`117- `x-ratelimit-reset-project-tokens`118119Project-token headers may be present when a project-scoped token limit applies.120121**OpenAI recommends logging request IDs in production deployments** for more efficient troubleshooting with the [support team](https://help.openai.com/en/), should the need arise. Official [client libraries](https://developers.openai.com/api/docs/libraries) provide a property on top-level response objects containing the value of the `x-request-id` header.122123### Supplying your own request ID with `X-Client-Request-Id`124125Along with the server-generated `x-request-id`, you can supply your own unique identifier for each request via the `X-Client-Request-Id` request header. This header isn't added automatically; you must explicitly set it on the request.126127When you include `X-Client-Request-Id`:128129- You control the ID format (for example, a UUID or your internal trace ID), but it must contain only ASCII characters and be no more than 512 characters long; otherwise, the request will fail with a 400 error. Make this value unique per request.130131- OpenAI logs this value internally for supported endpoints, including chat/completions, embeddings, responses, and more.132133- In cases like timeouts or network issues when you can't get the `X-Request-Id` response header, you can share the `X-Client-Request-Id` value with the support team to look up whether OpenAI received the request and when.134135**Example:**136137```bash138curl https://api.openai.com/v1/chat/completions \139 -H "Authorization: Bearer $OPENAI_API_KEY" \140 -H "X-Client-Request-Id: 123e4567-e89b-12d3-a456-426614174000"141```142143## Backwards compatibility144145OpenAI provides stability to API users by avoiding breaking changes in major API versions whenever reasonably possible. This includes:146147- The REST API (currently `v1`)148- First-party [client libraries](https://developers.openai.com/api/docs/libraries) (released libraries adhere to [semantic versioning](https://semver.org/))149- [Model](https://developers.openai.com/api/docs/models) families (like `gpt-4o` or `o4-mini`)150151**Model prompting behavior between snapshots is subject to change**.152Model outputs are by their nature variable, so expect changes in prompting and model behavior between snapshots. The best way to ensure consistent prompting behavior and model output is to use pinned model versions, and to run [evals](https://developers.openai.com/api/docs/guides/evals) for your applications.153154**Backwards-compatible API changes**:155156- Adding new resources (URLs) to the REST API and client libraries157- Adding new optional API parameters158- Adding new properties to JSON response objects or event data159- Changing the order of properties in a JSON response object160- Changing the length or format of opaque strings, like resource identifiers161- Adding new event types in streaming APIs162163See the [changelog](https://developers.openai.com/api/docs/changelog) for a list of backwards-compatible changes and rare breaking changes.164165---166167# Realtime Beta Overview168169Communicate with a multimodal model in real time over low latency interfaces like WebRTC, WebSocket, and SIP. Natively supports speech-to-speech as well as text, image, and audio inputs and outputs.170[Learn more about the Realtime API](https://developers.openai.com/docs/guides/realtime).171172---173174# Agents streaming events175176OpenAI API streaming event reference.177178Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/agents/streaming-events179180This API reference page is generated by Stainless.181182---183184# Audio185186OpenAI API endpoint reference.187188Canonical reference URL: https://developers.openai.com/api/reference/resources/audio189190This API reference page is generated by Stainless.191192---193194# Audio Speech — Create195196OpenAI API endpoint method reference.197198Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create199200This API reference page is generated by Stainless.201202---203204# Audio Transcriptions — Create205206OpenAI API endpoint method reference.207208Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create209210This API reference page is generated by Stainless.211212---213214# Audio Translations — Create215216OpenAI API endpoint method reference.217218Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create219220This API reference page is generated by Stainless.221222---223224# Audio Voice Consents — Create225226OpenAI API endpoint method reference.227228Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/create229230This API reference page is generated by Stainless.231232---233234# Audio Voice Consents — Delete235236OpenAI API endpoint method reference.237238Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/delete239240This API reference page is generated by Stainless.241242---243244# Audio Voice Consents — List245246OpenAI API endpoint method reference.247248Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/list249250This API reference page is generated by Stainless.251252---253254# Audio Voice Consents — Retrieve255256OpenAI API endpoint method reference.257258Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/retrieve259260This API reference page is generated by Stainless.261262---263264# Audio Voice Consents — Update265266OpenAI API endpoint method reference.267268Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/update269270This API reference page is generated by Stainless.271272---273274# Audio Voices — Create275276OpenAI API endpoint method reference.277278Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/voices/methods/create279280This API reference page is generated by Stainless.281282---283284# Batches285286OpenAI API endpoint reference.287288Canonical reference URL: https://developers.openai.com/api/reference/resources/batches289290This API reference page is generated by Stainless.291292---293294# Batches — Cancel295296OpenAI API endpoint method reference.297298Canonical reference URL: https://developers.openai.com/api/reference/resources/batches/methods/cancel299300This API reference page is generated by Stainless.301302---303304# Batches — Create305306OpenAI API endpoint method reference.307308Canonical reference URL: https://developers.openai.com/api/reference/resources/batches/methods/create309310This API reference page is generated by Stainless.311312---313314# Batches — List315316OpenAI API endpoint method reference.317318Canonical reference URL: https://developers.openai.com/api/reference/resources/batches/methods/list319320This API reference page is generated by Stainless.321322---323324# Batches — Retrieve325326OpenAI API endpoint method reference.327328Canonical reference URL: https://developers.openai.com/api/reference/resources/batches/methods/retrieve329330This API reference page is generated by Stainless.331332---333334# Beta Chatkit335336OpenAI API endpoint reference.337338Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit339340This API reference page is generated by Stainless.341342---343344# Beta Chatkit Sessions345346OpenAI API endpoint reference.347348Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/sessions349350This API reference page is generated by Stainless.351352---353354# Beta Chatkit Sessions — Cancel355356OpenAI API endpoint method reference.357358Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/sessions/methods/cancel359360This API reference page is generated by Stainless.361362---363364# Beta Chatkit Sessions — Create365366OpenAI API endpoint method reference.367368Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/sessions/methods/create369370This API reference page is generated by Stainless.371372---373374# Beta Chatkit Threads375376OpenAI API endpoint reference.377378Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads379380This API reference page is generated by Stainless.381382---383384# Beta Chatkit Threads — Delete385386OpenAI API endpoint method reference.387388Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads/methods/delete389390This API reference page is generated by Stainless.391392---393394# Beta Chatkit Threads — List395396OpenAI API endpoint method reference.397398Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads/methods/list399400This API reference page is generated by Stainless.401402---403404# Beta Chatkit Threads — List Items405406OpenAI API endpoint method reference.407408Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads/methods/list_items409410This API reference page is generated by Stainless.411412---413414# Beta Chatkit Threads — Retrieve415416OpenAI API endpoint method reference.417418Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads/methods/retrieve419420This API reference page is generated by Stainless.421422---423424# Beta Responses streaming events425426OpenAI API streaming event reference.427428Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/responses/streaming-events429430This API reference page is generated by Stainless.431432---433434# Beta Responses WebSocket events435436OpenAI API streaming event reference.437438Canonical reference URL: https://developers.openai.com/api/reference/resources/beta/subresources/responses/websocket-events439440This API reference page is generated by Stainless.441442---443444# Chat445446OpenAI API endpoint reference.447448Canonical reference URL: https://developers.openai.com/api/reference/resources/chat449450This API reference page is generated by Stainless.451452---453454# Chat Completions — Retrieve455456OpenAI API endpoint method reference.457458Canonical reference URL: https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/retrieve459460This API reference page is generated by Stainless.461462---463464# Chat Completions streaming events465466OpenAI API streaming event reference.467468Canonical reference URL: https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events469470This API reference page is generated by Stainless.471472---473474# Completions475476OpenAI API endpoint reference.477478Canonical reference URL: https://developers.openai.com/api/reference/resources/completions479480This API reference page is generated by Stainless.481482---483484# Completions — Create485486OpenAI API endpoint method reference.487488Canonical reference URL: https://developers.openai.com/api/reference/resources/completions/methods/create489490This API reference page is generated by Stainless.491492---493494# Containers495496OpenAI API endpoint reference.497498Canonical reference URL: https://developers.openai.com/api/reference/resources/containers499500This API reference page is generated by Stainless.501502---503504# Containers — Create505506OpenAI API endpoint method reference.507508Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/methods/create509510This API reference page is generated by Stainless.511512---513514# Containers — Delete515516OpenAI API endpoint method reference.517518Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/methods/delete519520This API reference page is generated by Stainless.521522---523524# Containers — List525526OpenAI API endpoint method reference.527528Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/methods/list529530This API reference page is generated by Stainless.531532---533534# Containers — Retrieve535536OpenAI API endpoint method reference.537538Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/methods/retrieve539540This API reference page is generated by Stainless.541542---543544# Containers Files545546OpenAI API endpoint reference.547548Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/subresources/files549550This API reference page is generated by Stainless.551552---553554# Containers Files — Create555556OpenAI API endpoint method reference.557558Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/subresources/files/methods/create559560This API reference page is generated by Stainless.561562---563564# Containers Files — Delete565566OpenAI API endpoint method reference.567568Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/subresources/files/methods/delete569570This API reference page is generated by Stainless.571572---573574# Containers Files — List575576OpenAI API endpoint method reference.577578Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/subresources/files/methods/list579580This API reference page is generated by Stainless.581582---583584# Containers Files — Retrieve585586OpenAI API endpoint method reference.587588Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/subresources/files/methods/retrieve589590This API reference page is generated by Stainless.591592---593594# Containers Files Content — Retrieve595596OpenAI API endpoint method reference.597598Canonical reference URL: https://developers.openai.com/api/reference/resources/containers/subresources/files/subresources/content/methods/retrieve599600This API reference page is generated by Stainless.601602---603604# Conversations605606OpenAI API endpoint reference.607608Canonical reference URL: https://developers.openai.com/api/reference/resources/conversations609610This API reference page is generated by Stainless.611612---613614# Conversations — Create615616OpenAI API endpoint method reference.617618Canonical reference URL: https://developers.openai.com/api/reference/resources/conversations/methods/create619620This API reference page is generated by Stainless.621622---623624# Conversations — Delete625626OpenAI API endpoint method reference.627628Canonical reference URL: https://developers.openai.com/api/reference/resources/conversations/methods/delete629630This API reference page is generated by Stainless.631632---633634# Conversations — Retrieve635636OpenAI API endpoint method reference.637638Canonical reference URL: https://developers.openai.com/api/reference/resources/conversations/methods/retrieve639640This API reference page is generated by Stainless.641642---643644# Conversations — Update645646OpenAI API endpoint method reference.647648Canonical reference URL: https://developers.openai.com/api/reference/resources/conversations/methods/update649650This API reference page is generated by Stainless.651652---653654# Conversations Items — List655656OpenAI API endpoint method reference.657658Canonical reference URL: https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list659660This API reference page is generated by Stainless.661662---663664# Embeddings665666OpenAI API endpoint reference.667668Canonical reference URL: https://developers.openai.com/api/reference/resources/embeddings669670This API reference page is generated by Stainless.671672---673674# Embeddings — Create675676OpenAI API endpoint method reference.677678Canonical reference URL: https://developers.openai.com/api/reference/resources/embeddings/methods/create679680This API reference page is generated by Stainless.681682---683684# Evals685686OpenAI API endpoint reference.687688Canonical reference URL: https://developers.openai.com/api/reference/resources/evals689690This API reference page is generated by Stainless.691692---693694# Evals — Create695696OpenAI API endpoint method reference.697698Canonical reference URL: https://developers.openai.com/api/reference/resources/evals/methods/create699700This API reference page is generated by Stainless.701702---703704# Evals — Delete705706OpenAI API endpoint method reference.707708Canonical reference URL: https://developers.openai.com/api/reference/resources/evals/methods/delete709710This API reference page is generated by Stainless.711712---713714# Evals — List715716OpenAI API endpoint method reference.717718Canonical reference URL: https://developers.openai.com/api/reference/resources/evals/methods/list719720This API reference page is generated by Stainless.721722---723724# Evals — Retrieve725726OpenAI API endpoint method reference.727728Canonical reference URL: https://developers.openai.com/api/reference/resources/evals/methods/retrieve729730This API reference page is generated by Stainless.731732---733734# Evals — Update735736OpenAI API endpoint method reference.737738Canonical reference URL: https://developers.openai.com/api/reference/resources/evals/methods/update739740This API reference page is generated by Stainless.741742---743744# Evals Runs — Cancel745746OpenAI API endpoint method reference.747748Canonical reference URL: https://developers.openai.com/api/reference/resources/evals/subresources/runs/methods/cancel749750This API reference page is generated by Stainless.751752---753754# Files755756OpenAI API endpoint reference.757758Canonical reference URL: https://developers.openai.com/api/reference/resources/files759760This API reference page is generated by Stainless.761762---763764# Files — Create765766OpenAI API endpoint method reference.767768Canonical reference URL: https://developers.openai.com/api/reference/resources/files/methods/create769770This API reference page is generated by Stainless.771772---773774# Files — Delete775776OpenAI API endpoint method reference.777778Canonical reference URL: https://developers.openai.com/api/reference/resources/files/methods/delete779780This API reference page is generated by Stainless.781782---783784# Files — List785786OpenAI API endpoint method reference.787788Canonical reference URL: https://developers.openai.com/api/reference/resources/files/methods/list789790This API reference page is generated by Stainless.791792---793794# Files — Retrieve795796OpenAI API endpoint method reference.797798Canonical reference URL: https://developers.openai.com/api/reference/resources/files/methods/retrieve799800This API reference page is generated by Stainless.801802---803804# Fine Tuning805806OpenAI API endpoint reference.807808Canonical reference URL: https://developers.openai.com/api/reference/resources/fine_tuning809810This API reference page is generated by Stainless.811812---813814# Fine Tuning Checkpoints Permissions — Create815816OpenAI API endpoint method reference.817818Canonical reference URL: https://developers.openai.com/api/reference/resources/fine_tuning/subresources/checkpoints/subresources/permissions/methods/create819820This API reference page is generated by Stainless.821822---823824# Fine Tuning Checkpoints Permissions — Delete825826OpenAI API endpoint method reference.827828Canonical reference URL: https://developers.openai.com/api/reference/resources/fine_tuning/subresources/checkpoints/subresources/permissions/methods/delete829830This API reference page is generated by Stainless.831832---833834# Fine Tuning Jobs — List835836OpenAI API endpoint method reference.837838Canonical reference URL: https://developers.openai.com/api/reference/resources/fine_tuning/subresources/jobs/methods/list839840This API reference page is generated by Stainless.841842---843844# Fine Tuning Jobs Checkpoints — List845846OpenAI API endpoint method reference.847848Canonical reference URL: https://developers.openai.com/api/reference/resources/fine_tuning/subresources/jobs/subresources/checkpoints/methods/list849850This API reference page is generated by Stainless.851852---853854# Graders855856OpenAI API endpoint reference.857858Canonical reference URL: https://developers.openai.com/api/reference/resources/graders859860This API reference page is generated by Stainless.861862---863864# Image edit streaming events865866OpenAI API streaming event reference.867868Canonical reference URL: https://developers.openai.com/api/reference/resources/images/edit-streaming-events869870This API reference page is generated by Stainless.871872---873874# Image generation streaming events875876OpenAI API streaming event reference.877878Canonical reference URL: https://developers.openai.com/api/reference/resources/images/generation-streaming-events879880This API reference page is generated by Stainless.881882---883884# Images885886OpenAI API endpoint reference.887888Canonical reference URL: https://developers.openai.com/api/reference/resources/images889890This API reference page is generated by Stainless.891892---893894# Images — Create Variation895896OpenAI API endpoint method reference.897898Canonical reference URL: https://developers.openai.com/api/reference/resources/images/methods/create_variation899900This API reference page is generated by Stainless.901902---903904# Live fork WebSocket905906OpenAI API streaming event reference.907908Canonical reference URL: https://developers.openai.com/api/reference/resources/live/fork-websocket909910This API reference page is generated by Stainless.911912---913914# Live primary WebSocket915916OpenAI API streaming event reference.917918Canonical reference URL: https://developers.openai.com/api/reference/resources/live/primary-websocket919920This API reference page is generated by Stainless.921922---923924# Live sideband WebSocket925926OpenAI API streaming event reference.927928Canonical reference URL: https://developers.openai.com/api/reference/resources/live/sideband-websocket929930This API reference page is generated by Stainless.931932---933934# Models935936OpenAI API endpoint reference.937938Canonical reference URL: https://developers.openai.com/api/reference/resources/models939940This API reference page is generated by Stainless.941942---943944# Models — Delete945946OpenAI API endpoint method reference.947948Canonical reference URL: https://developers.openai.com/api/reference/resources/models/methods/delete949950This API reference page is generated by Stainless.951952---953954# Models — List955956OpenAI API endpoint method reference.957958Canonical reference URL: https://developers.openai.com/api/reference/resources/models/methods/list959960This API reference page is generated by Stainless.961962---963964# Models — Retrieve965966OpenAI API endpoint method reference.967968Canonical reference URL: https://developers.openai.com/api/reference/resources/models/methods/retrieve969970This API reference page is generated by Stainless.971972---973974# Moderations975976OpenAI API endpoint reference.977978Canonical reference URL: https://developers.openai.com/api/reference/resources/moderations979980This API reference page is generated by Stainless.981982---983984# Moderations — Create985986OpenAI API endpoint method reference.987988Canonical reference URL: https://developers.openai.com/api/reference/resources/moderations/methods/create989990This API reference page is generated by Stainless.991992---993994# Organization995996OpenAI API endpoint reference.997998Canonical reference URL: https://developers.openai.com/api/reference/resources/organization9991000This API reference page is generated by Stainless.10011002---10031004# Organization Audit Logs10051006OpenAI API endpoint reference.10071008Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs10091010This API reference page is generated by Stainless.10111012---10131014# Organization Audit Logs — List10151016OpenAI API endpoint method reference.10171018Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list10191020This API reference page is generated by Stainless.10211022---10231024# Organization Audit Logs Admin Api Keys10251026OpenAI API endpoint reference.10271028Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys10291030This API reference page is generated by Stainless.10311032---10331034# Organization Audit Logs Admin Api Keys — Create10351036OpenAI API endpoint method reference.10371038Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/create10391040This API reference page is generated by Stainless.10411042---10431044# Organization Audit Logs Admin Api Keys — Delete10451046OpenAI API endpoint method reference.10471048Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/delete10491050This API reference page is generated by Stainless.10511052---10531054# Organization Audit Logs Admin Api Keys — List10551056OpenAI API endpoint method reference.10571058Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/list10591060This API reference page is generated by Stainless.10611062---10631064# Organization Audit Logs Admin Api Keys — Retrieve10651066OpenAI API endpoint method reference.10671068Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/retrieve10691070This API reference page is generated by Stainless.10711072---10731074# Organization Audit Logs Usage10751076OpenAI API endpoint reference.10771078Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/usage10791080This API reference page is generated by Stainless.10811082---10831084# Organization Groups10851086OpenAI API endpoint reference.10871088Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups10891090This API reference page is generated by Stainless.10911092---10931094# Organization Groups — Create10951096OpenAI API endpoint method reference.10971098Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/create10991100This API reference page is generated by Stainless.11011102---11031104# Organization Groups — Delete11051106OpenAI API endpoint method reference.11071108Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/delete11091110This API reference page is generated by Stainless.11111112---11131114# Organization Groups — List11151116OpenAI API endpoint method reference.11171118Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/list11191120This API reference page is generated by Stainless.11211122---11231124# Organization Groups — Update11251126OpenAI API endpoint method reference.11271128Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/update11291130This API reference page is generated by Stainless.11311132---11331134# Organization Groups Users11351136OpenAI API endpoint reference.11371138Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users11391140This API reference page is generated by Stainless.11411142---11431144# Organization Groups Users — Create11451146OpenAI API endpoint method reference.11471148Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/create11491150This API reference page is generated by Stainless.11511152---11531154# Organization Groups Users — Delete11551156OpenAI API endpoint method reference.11571158Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/delete11591160This API reference page is generated by Stainless.11611162---11631164# Organization Groups Users — List11651166OpenAI API endpoint method reference.11671168Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list11691170This API reference page is generated by Stainless.11711172---11731174# Organization Invites11751176OpenAI API endpoint reference.11771178Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites11791180This API reference page is generated by Stainless.11811182---11831184# Organization Invites — Create11851186OpenAI API endpoint method reference.11871188Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create11891190This API reference page is generated by Stainless.11911192---11931194# Organization Invites — Delete11951196OpenAI API endpoint method reference.11971198Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/delete11991200This API reference page is generated by Stainless.12011202---12031204# Organization Invites — List12051206OpenAI API endpoint method reference.12071208Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/list12091210This API reference page is generated by Stainless.12111212---12131214# Organization Invites — Retrieve12151216OpenAI API endpoint method reference.12171218Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/retrieve12191220This API reference page is generated by Stainless.12211222---12231224# Organization Projects12251226OpenAI API endpoint reference.12271228Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects12291230This API reference page is generated by Stainless.12311232---12331234# Organization Projects — Create12351236OpenAI API endpoint method reference.12371238Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create12391240This API reference page is generated by Stainless.12411242---12431244# Organization Projects — List12451246OpenAI API endpoint method reference.12471248Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/list12491250This API reference page is generated by Stainless.12511252---12531254# Organization Projects — Retrieve12551256OpenAI API endpoint method reference.12571258Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/retrieve12591260This API reference page is generated by Stainless.12611262---12631264# Organization Projects — Update12651266OpenAI API endpoint method reference.12671268Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update12691270This API reference page is generated by Stainless.12711272---12731274# Organization Projects Api Keys12751276OpenAI API endpoint reference.12771278Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys12791280This API reference page is generated by Stainless.12811282---12831284# Organization Projects Api Keys — Delete12851286OpenAI API endpoint method reference.12871288Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/delete12891290This API reference page is generated by Stainless.12911292---12931294# Organization Projects Api Keys — List12951296OpenAI API endpoint method reference.12971298Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list12991300This API reference page is generated by Stainless.13011302---13031304# Organization Projects Api Keys — Retrieve13051306OpenAI API endpoint method reference.13071308Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/retrieve13091310This API reference page is generated by Stainless.13111312---13131314# Organization Projects Groups13151316OpenAI API endpoint reference.13171318Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups13191320This API reference page is generated by Stainless.13211322---13231324# Organization Projects Groups — Delete13251326OpenAI API endpoint method reference.13271328Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/delete13291330This API reference page is generated by Stainless.13311332---13331334# Organization Projects Groups — List13351336OpenAI API endpoint method reference.13371338Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list13391340This API reference page is generated by Stainless.13411342---13431344# Organization Projects Rate Limits13451346OpenAI API endpoint reference.13471348Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/rate_limits13491350This API reference page is generated by Stainless.13511352---13531354# Organization Projects Service Accounts13551356OpenAI API endpoint reference.13571358Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts13591360This API reference page is generated by Stainless.13611362---13631364# Organization Projects Service Accounts — Create13651366OpenAI API endpoint method reference.13671368Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create13691370This API reference page is generated by Stainless.13711372---13731374# Organization Projects Service Accounts — Delete13751376OpenAI API endpoint method reference.13771378Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/delete13791380This API reference page is generated by Stainless.13811382---13831384# Organization Projects Service Accounts — List13851386OpenAI API endpoint method reference.13871388Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/list13891390This API reference page is generated by Stainless.13911392---13931394# Organization Projects Service Accounts — Retrieve13951396OpenAI API endpoint method reference.13971398Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/retrieve13991400This API reference page is generated by Stainless.14011402---14031404# Organization Projects Users14051406OpenAI API endpoint reference.14071408Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users14091410This API reference page is generated by Stainless.14111412---14131414# Organization Projects Users — Create14151416OpenAI API endpoint method reference.14171418Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create14191420This API reference page is generated by Stainless.14211422---14231424# Organization Projects Users — Delete14251426OpenAI API endpoint method reference.14271428Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/delete14291430This API reference page is generated by Stainless.14311432---14331434# Organization Projects Users — List14351436OpenAI API endpoint method reference.14371438Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/list14391440This API reference page is generated by Stainless.14411442---14431444# Organization Projects Users — Retrieve14451446OpenAI API endpoint method reference.14471448Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/retrieve14491450This API reference page is generated by Stainless.14511452---14531454# Organization Projects Users — Update14551456OpenAI API endpoint method reference.14571458Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/update14591460This API reference page is generated by Stainless.14611462---14631464# Organization Roles14651466OpenAI API endpoint reference.14671468Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles14691470This API reference page is generated by Stainless.14711472---14731474# Organization Roles — Create14751476OpenAI API endpoint method reference.14771478Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/create14791480This API reference page is generated by Stainless.14811482---14831484# Organization Roles — Delete14851486OpenAI API endpoint method reference.14871488Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/delete14891490This API reference page is generated by Stainless.14911492---14931494# Organization Roles — List14951496OpenAI API endpoint method reference.14971498Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/list14991500This API reference page is generated by Stainless.15011502---15031504# Organization Roles — Update15051506OpenAI API endpoint method reference.15071508Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update15091510This API reference page is generated by Stainless.15111512---15131514# Organization Users15151516OpenAI API endpoint reference.15171518Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users15191520This API reference page is generated by Stainless.15211522---15231524# Organization Users — Delete15251526OpenAI API endpoint method reference.15271528Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/delete15291530This API reference page is generated by Stainless.15311532---15331534# Organization Users — List15351536OpenAI API endpoint method reference.15371538Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/list15391540This API reference page is generated by Stainless.15411542---15431544# Organization Users — Retrieve15451546OpenAI API endpoint method reference.15471548Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/retrieve15491550This API reference page is generated by Stainless.15511552---15531554# Organization Users — Update15551556OpenAI API endpoint method reference.15571558Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update15591560This API reference page is generated by Stainless.15611562---15631564# Organization Users Roles — Create15651566OpenAI API endpoint method reference.15671568Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/create15691570This API reference page is generated by Stainless.15711572---15731574# Organization Users Roles — Delete15751576OpenAI API endpoint method reference.15771578Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/delete15791580This API reference page is generated by Stainless.15811582---15831584# Organization Users Roles — List15851586OpenAI API endpoint method reference.15871588Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list15891590This API reference page is generated by Stainless.15911592---15931594# Projects15951596OpenAI API endpoint reference.15971598Canonical reference URL: https://developers.openai.com/api/reference/resources/projects15991600This API reference page is generated by Stainless.16011602---16031604# Projects Groups16051606OpenAI API endpoint reference.16071608Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups16091610This API reference page is generated by Stainless.16111612---16131614# Projects Groups Roles — Create16151616OpenAI API endpoint method reference.16171618Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/create16191620This API reference page is generated by Stainless.16211622---16231624# Projects Groups Roles — Delete16251626OpenAI API endpoint method reference.16271628Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/delete16291630This API reference page is generated by Stainless.16311632---16331634# Projects Groups Roles — List16351636OpenAI API endpoint method reference.16371638Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list16391640This API reference page is generated by Stainless.16411642---16431644# Projects Roles — Create16451646OpenAI API endpoint method reference.16471648Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create16491650This API reference page is generated by Stainless.16511652---16531654# Projects Roles — Delete16551656OpenAI API endpoint method reference.16571658Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/delete16591660This API reference page is generated by Stainless.16611662---16631664# Projects Roles — List16651666OpenAI API endpoint method reference.16671668Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list16691670This API reference page is generated by Stainless.16711672---16731674# Projects Roles — Update16751676OpenAI API endpoint method reference.16771678Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update16791680This API reference page is generated by Stainless.16811682---16831684# Projects Users16851686OpenAI API endpoint reference.16871688Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users16891690This API reference page is generated by Stainless.16911692---16931694# Projects Users Roles — Create16951696OpenAI API endpoint method reference.16971698Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/create16991700This API reference page is generated by Stainless.17011702---17031704# Projects Users Roles — Delete17051706OpenAI API endpoint method reference.17071708Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/delete17091710This API reference page is generated by Stainless.17111712---17131714# Projects Users Roles — List17151716OpenAI API endpoint method reference.17171718Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list17191720This API reference page is generated by Stainless.17211722---17231724# Realtime17251726OpenAI API endpoint reference.17271728Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime17291730This API reference page is generated by Stainless.17311732---17331734# Realtime Calls17351736OpenAI API endpoint reference.17371738Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/calls17391740This API reference page is generated by Stainless.17411742---17431744# Realtime Calls — Accept17451746OpenAI API endpoint method reference.17471748Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept17491750This API reference page is generated by Stainless.17511752---17531754# Realtime Calls — Create17551756OpenAI API endpoint method reference.17571758Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create17591760This API reference page is generated by Stainless.17611762---17631764# Realtime Calls — Hangup17651766OpenAI API endpoint method reference.17671768Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/hangup17691770This API reference page is generated by Stainless.17711772---17731774# Realtime Calls — Refer17751776OpenAI API endpoint method reference.17771778Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/refer17791780This API reference page is generated by Stainless.17811782---17831784# Realtime Calls — Reject17851786OpenAI API endpoint method reference.17871788Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/reject17891790This API reference page is generated by Stainless.17911792---17931794# Realtime client events17951796OpenAI API streaming event reference.17971798Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/client-events17991800This API reference page is generated by Stainless.18011802---18031804# Realtime Client Secrets18051806OpenAI API endpoint reference.18071808Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets18091810This API reference page is generated by Stainless.18111812---18131814# Realtime Client Secrets — Create18151816OpenAI API endpoint method reference.18171818Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create18191820This API reference page is generated by Stainless.18211822---18231824# Realtime server events18251826OpenAI API streaming event reference.18271828Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/server-events18291830This API reference page is generated by Stainless.18311832---18331834# Realtime translation client events18351836OpenAI API streaming event reference.18371838Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/translation-client-events18391840This API reference page is generated by Stainless.18411842---18431844# Realtime translation server events18451846OpenAI API streaming event reference.18471848Canonical reference URL: https://developers.openai.com/api/reference/resources/realtime/translation-server-events18491850This API reference page is generated by Stainless.18511852---18531854# Responses18551856OpenAI API endpoint reference.18571858Canonical reference URL: https://developers.openai.com/api/reference/resources/responses18591860This API reference page is generated by Stainless.18611862---18631864# Responses — Cancel18651866OpenAI API endpoint method reference.18671868Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/methods/cancel18691870This API reference page is generated by Stainless.18711872---18731874# Responses — Compact18751876OpenAI API endpoint method reference.18771878Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/methods/compact18791880This API reference page is generated by Stainless.18811882---18831884# Responses — Create18851886OpenAI API endpoint method reference.18871888Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/methods/create18891890This API reference page is generated by Stainless.18911892---18931894# Responses — Delete18951896OpenAI API endpoint method reference.18971898Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/methods/delete18991900This API reference page is generated by Stainless.19011902---19031904# Responses — Retrieve19051906OpenAI API endpoint method reference.19071908Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/methods/retrieve19091910This API reference page is generated by Stainless.19111912---19131914# Responses Input Items — List19151916OpenAI API endpoint method reference.19171918Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/subresources/input_items/methods/list19191920This API reference page is generated by Stainless.19211922---19231924# Responses Input Tokens19251926OpenAI API endpoint reference.19271928Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens19291930This API reference page is generated by Stainless.19311932---19331934# Responses streaming events19351936OpenAI API streaming event reference.19371938Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/streaming-events19391940This API reference page is generated by Stainless.19411942---19431944# Responses WebSocket events19451946OpenAI API streaming event reference.19471948Canonical reference URL: https://developers.openai.com/api/reference/resources/responses/websocket-events19491950This API reference page is generated by Stainless.19511952---19531954# Transcription streaming events19551956OpenAI API streaming event reference.19571958Canonical reference URL: https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/streaming-events19591960This API reference page is generated by Stainless.19611962---19631964# Unwrap19651966Unwrap is a convenience helper available in the official SDKs to verify a webhook signature and parse the JSON payload in a single call. Use `client.webhooks.unwrap(body, headers, options?)` to verify the signature and parse the JSON payload in one call. For end-to-end webhook examples, see the [Webhooks guide](https://developers.openai.com/api/docs/guides/webhooks).19671968## Supported SDKs19691970This helper is available in official SDKs, including:19711972- [JavaScript / TypeScript](https://developers.openai.com/api/reference/typescript/resources/webhooks/methods/unwrap)1973- [Python](https://developers.openai.com/api/reference/python/resources/webhooks/methods/unwrap)1974- [Ruby](https://developers.openai.com/api/reference/ruby/resources/webhooks/methods/unwrap)1975- [Go](https://developers.openai.com/api/reference/go/resources/webhooks/methods/unwrap)19761977---19781979# Uploads19801981OpenAI API endpoint reference.19821983Canonical reference URL: https://developers.openai.com/api/reference/resources/uploads19841985This API reference page is generated by Stainless.19861987---19881989# Uploads — Cancel19901991OpenAI API endpoint method reference.19921993Canonical reference URL: https://developers.openai.com/api/reference/resources/uploads/methods/cancel19941995This API reference page is generated by Stainless.19961997---19981999# Uploads — Create20002001OpenAI API endpoint method reference.20022003Canonical reference URL: https://developers.openai.com/api/reference/resources/uploads/methods/create20042005This API reference page is generated by Stainless.20062007---20082009# Uploads Parts — Create20102011OpenAI API endpoint method reference.20122013Canonical reference URL: https://developers.openai.com/api/reference/resources/uploads/subresources/parts/methods/create20142015This API reference page is generated by Stainless.20162017---20182019# Vector Stores20202021OpenAI API endpoint reference.20222023Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores20242025This API reference page is generated by Stainless.20262027---20282029# Vector Stores — Create20302031OpenAI API endpoint method reference.20322033Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/methods/create20342035This API reference page is generated by Stainless.20362037---20382039# Vector Stores — Delete20402041OpenAI API endpoint method reference.20422043Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/methods/delete20442045This API reference page is generated by Stainless.20462047---20482049# Vector Stores — List20502051OpenAI API endpoint method reference.20522053Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/methods/list20542055This API reference page is generated by Stainless.20562057---20582059# Vector Stores — Retrieve20602061OpenAI API endpoint method reference.20622063Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/methods/retrieve20642065This API reference page is generated by Stainless.20662067---20682069# Vector Stores — Search20702071OpenAI API endpoint method reference.20722073Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/methods/search20742075This API reference page is generated by Stainless.20762077---20782079# Vector Stores — Update20802081OpenAI API endpoint method reference.20822083Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/methods/update20842085This API reference page is generated by Stainless.20862087---20882089# Vector Stores File Batches20902091OpenAI API endpoint reference.20922093Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches20942095This API reference page is generated by Stainless.20962097---20982099# Vector Stores File Batches — Cancel21002101OpenAI API endpoint method reference.21022103Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/cancel21042105This API reference page is generated by Stainless.21062107---21082109# Vector Stores File Batches — Create21102111OpenAI API endpoint method reference.21122113Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create21142115This API reference page is generated by Stainless.21162117---21182119# Vector Stores File Batches — List Files21202121OpenAI API endpoint method reference.21222123Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/list_files21242125This API reference page is generated by Stainless.21262127---21282129# Vector Stores File Batches — Retrieve21302131OpenAI API endpoint method reference.21322133Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/retrieve21342135This API reference page is generated by Stainless.21362137---21382139# Vector Stores Files21402141OpenAI API endpoint reference.21422143Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/files21442145This API reference page is generated by Stainless.21462147---21482149# Vector Stores Files — Content21502151OpenAI API endpoint method reference.21522153Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/files/methods/content21542155This API reference page is generated by Stainless.21562157---21582159# Vector Stores Files — Create21602161OpenAI API endpoint method reference.21622163Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/files/methods/create21642165This API reference page is generated by Stainless.21662167---21682169# Vector Stores Files — Delete21702171OpenAI API endpoint method reference.21722173Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/files/methods/delete21742175This API reference page is generated by Stainless.21762177---21782179# Vector Stores Files — List21802181OpenAI API endpoint method reference.21822183Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/files/methods/list21842185This API reference page is generated by Stainless.21862187---21882189# Vector Stores Files — Retrieve21902191OpenAI API endpoint method reference.21922193Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/files/methods/retrieve21942195This API reference page is generated by Stainless.21962197---21982199# Vector Stores Files — Update22002201OpenAI API endpoint method reference.22022203Canonical reference URL: https://developers.openai.com/api/reference/resources/vector_stores/subresources/files/methods/update22042205This API reference page is generated by Stainless.22062207---22082209# Videos22102211OpenAI API endpoint reference.22122213Canonical reference URL: https://developers.openai.com/api/reference/resources/videos22142215This API reference page is generated by Stainless.22162217---22182219# Videos — Create22202221OpenAI API endpoint method reference.22222223Canonical reference URL: https://developers.openai.com/api/reference/resources/videos/methods/create22242225This API reference page is generated by Stainless.22262227---22282229# Videos — Delete22302231OpenAI API endpoint method reference.22322233Canonical reference URL: https://developers.openai.com/api/reference/resources/videos/methods/delete22342235This API reference page is generated by Stainless.22362237---22382239# Videos — List22402241OpenAI API endpoint method reference.22422243Canonical reference URL: https://developers.openai.com/api/reference/resources/videos/methods/list22442245This API reference page is generated by Stainless.22462247---22482249# Videos — Retrieve22502251OpenAI API endpoint method reference.22522253Canonical reference URL: https://developers.openai.com/api/reference/resources/videos/methods/retrieve22542255This API reference page is generated by Stainless.22562257---22582259# Webhooks events22602261OpenAI API streaming event reference.22622263Canonical reference URL: https://developers.openai.com/api/reference/resources/webhooks22642265This API reference page is generated by Stainless.22662267---22682269# Responses Overview22702271OpenAI's most advanced interface for generating model responses. Supports2272text and image inputs, and text outputs. Create stateful interactions2273with the model, using the output of previous responses as input. Extend2274the model's capabilities with built-in tools for file search, web search,2275computer use, and more. Allow the model access to external systems and data2276using function calling.22772278Related guides:22792280- [Quickstart](https://developers.openai.com/docs/quickstart?api-mode=responses)2281- [Text inputs and outputs](https://developers.openai.com/docs/guides/text?api-mode=responses)2282- [Image inputs](https://developers.openai.com/docs/guides/images?api-mode=responses)2283- [Structured Outputs](https://developers.openai.com/docs/guides/structured-outputs?api-mode=responses)2284- [Function calling](https://developers.openai.com/docs/guides/function-calling?api-mode=responses)2285- [Conversation state](https://developers.openai.com/docs/guides/conversation-state?api-mode=responses)2286- [WebSocket mode](https://developers.openai.com/docs/guides/websocket-mode)2287- [Extend the models with tools](https://developers.openai.com/docs/guides/tools?api-mode=responses)22882289---22902291# Workload identity token exchange22922293Use this reference to exchange an externally issued identity token for a short-lived OpenAI access token after you configure a trusted provider and service account mapping. It also describes the X.509 certificate exchange. For concepts, dashboard configuration, and setup guides, see the [workload identity federation guide](https://developers.openai.com/api/docs/guides/workload-identity-federation).22942295## Exchange a JWT subject token22962297Exchange the external subject token at the OpenAI token endpoint:22982299```bash2300curl https://auth.openai.com/oauth/token \2301 -H "Content-Type: application/json" \2302 -d '{2303 "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",2304 "subject_token_type": "urn:ietf:params:oauth:token-type:jwt",2305 "subject_token": "'"$EXTERNAL_OIDC_JWT"'",2306 "identity_provider_id": "'"$IDENTITY_PROVIDER_ID"'",2307 "service_account_id": "'"$SERVICE_ACCOUNT_ID"'"2308 }'2309```23102311### Request parameters23122313| Parameter | Required | Description |2314| ---------------------- | -------- | ------------------------------------------------------------------------------------------------ |2315| `grant_type` | Yes | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. |2316| `subject_token_type` | Yes | Supports `urn:ietf:params:oauth:token-type:jwt` and `urn:ietf:params:oauth:token-type:id_token`. |2317| `subject_token` | Yes | The externally issued OIDC JWT or SPIFFE JWT-SVID from your Workload Identity Provider. |2318| `identity_provider_id` | Yes | The OpenAI Workload Identity Provider ID configured for the external issuer. |2319| `service_account_id` | Yes | The OpenAI service account ID to resolve against the matching service account mapping. |23202321The token exchange uses the permissions configured on the matching service account mapping. A `scope` value in the request body doesn't grant access.23222323## Exchange an X.509 certificate23242325Present the client certificate during TLS negotiation with the dedicated X.509 token endpoint. Don't include a `subject_token` in the request body.23262327For provider and service account mapping configuration, follow the [X.509 certificate setup guide](https://developers.openai.com/api/docs/guides/workload-identity-federation/x509). For certificate requirements, activation, mTLS hosts, CEL filters, and rotation, see the [Mutual TLS guide](https://developers.openai.com/api/docs/guides/mutual-tls).23282329```bash2330curl --cert "$OPENAI_MTLS_CERT_CHAIN" \2331 --key "$OPENAI_MTLS_KEY" \2332 --request POST "https://mtls.auth.openai.com/oauth/token" \2333 --header "Content-Type: application/json" \2334 --data @- <<JSON2335{2336 "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",2337 "subject_token_type": "urn:openai:params:oauth:token-type:x509",2338 "identity_provider_id": "${OPENAI_IDENTITY_PROVIDER_ID}",2339 "service_account_id": "${OPENAI_SERVICE_ACCOUNT_ID}"2340}2341JSON2342```23432344### X.509 request parameters23452346| Parameter | Required | Description |2347| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |2348| `grant_type` | Yes | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. |2349| `subject_token_type` | Yes | Must be `urn:openai:params:oauth:token-type:x509`. |2350| `identity_provider_id` | Yes | The OpenAI X.509 Workload Identity Provider ID. |2351| `service_account_id` | Yes | The OpenAI service account ID to resolve against the provider's service account mappings. |2352| `subject_token` | No | Omit this parameter. OpenAI obtains certificate identity only from the authenticated TLS connection. |23532354The X.509 endpoint accepts only exact `POST /oauth/token` requests on `mtls.auth.openai.com`. Other methods and paths return HTTP `403`.23552356## Identity validation23572358### JWT subject token validation23592360OpenAI verifies the external subject token before resolving a mapping. The token must:23612362- Be a JWT with a `kid` and supported `alg` in the header.2363- Include `iss`, `aud`, `sub`, `exp`, and `iat` claims.2364- Match the configured Workload Identity Provider issuer and audience.2365- Be signed by a key from the configured JWKS source.23662367If verification fails, the token exchange returns an authentication error and doesn't mint an OpenAI access token.23682369After subject token validation succeeds, OpenAI resolves the requested service account mapping against the token's raw claims and derived attributes. Mapping mismatches fail the token exchange during mapping resolution.23702371### X.509 certificate validation23722373OpenAI verifies the client certificate against active Mutual TLS roots in the resolved organization and project context. The client must present any intermediate certificates required to build the path. OpenAI doesn't fetch missing intermediates from certificate URLs.23742375During certificate validation, OpenAI applies the certificate-admission rules configured with the active Mutual TLS root. After validation succeeds, OpenAI evaluates the provider's **Attribute conditions**, derives its `openai.*` attributes, and resolves exactly one enabled mapping for the requested service account. X.509 providers must derive one non-empty `openai.subject` value.23762377Malformed or missing certificate material, an invalid chain, a root mismatch, a certificate outside its validity period, or rejection by a Mutual TLS certificate-admission rule returns `invalid_subject_token`. Rejection by the provider's **Attribute conditions** expression returns `invalid_grant`. Other provider, mapping, or active-root configuration failures also return `invalid_grant`. X.509 requests never fall back to OIDC or another OAuth flow.23782379## Response23802381Successful responses include a short-lived bearer token:23822383```json2384{2385 "access_token": "eyJ...",2386 "issued_token_type": "urn:ietf:params:oauth:token-type:access_token",2387 "token_type": "Bearer",2388 "expires_in": 3600,2389 "expires_at": 1789045200,2390 "scope": "api.model.read api.model.request"2391}2392```23932394The response includes these expiration fields for both JWT and X.509 exchanges:23952396| Field | Type | Description |2397| ------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |2398| `expires_in` | Integer | Access-token lifetime in seconds, measured from issuance (`iat`). Time spent processing or delivering the response consumes part of this lifetime. |2399| `expires_at` | Integer | Absolute expiration as a Unix timestamp in seconds since January 1, 1970, at 00:00:00 UTC. Equals the issued access token's `exp` claim. |24002401The `scope` property is returned only when the resolved mapping has permissions. Access tokens expire after at most one hour. A JWT exchange token never outlives its external subject token, and an X.509 exchange token never outlives the verified client certificate. Token exchange doesn't return a refresh token.24022403The expiration values in the example are illustrative. The returned lifetime can be shorter when the external subject token or verified client certificate expires sooner. For scheduling another exchange, see [token renewal guidance](https://developers.openai.com/api/docs/guides/workload-identity-federation#renew-the-access-token).24042405## Token exchange errors24062407If token exchange fails, OpenAI doesn't mint an access token. Common causes include:24082409| Error category | Typical causes |2410| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |2411| Missing JWT request parameter | `subject_token`, `subject_token_type`, `identity_provider_id`, or `service_account_id` is missing from a JWT exchange. |2412| Unsupported token request | `subject_token_type` isn't a supported JWT type or the X.509 token type, or the request uses fields that aren't accepted for that mode. |2413| Provider resolution error | The Workload Identity Provider ID is malformed, unknown, disabled, or incompatible with the requested exchange mode. |2414| JWT subject token verification | The JWT is malformed, the header is missing `kid` or `alg`, the algorithm is unsupported, the signature is invalid, the issuer or audience doesn't match, a required claim is missing, the token is expired, or no JWKS key matches the token `kid`. |2415| X.509 certificate verification | The client certificate is missing or malformed, the presented path doesn't reach an active root, the certificate is outside its validity period, or it doesn't satisfy configured certificate rules. |2416| Mapping resolution | No mapping exists for the requested service account, the matching mapping is disabled, the identity attributes don't match the mapping, or an attribute transformation fails. |24172418Most subject-token problems are visible by decoding the JWT payload locally and comparing its `iss`, `aud`, `sub`, `exp`, `iat`, and provider-specific claims with your Workload Identity Provider and service account mapping configuration.24192420If token exchange succeeds but a later OpenAI API request fails, debug the minted access token as an authorization issue. The token still has the project, service account, endpoint authorization, IP allowlist, and other policy checks that apply to normal OpenAI API requests. An X.509 workload must also send an accepted client certificate to `mtls.api.openai.com` on the API request.24212422## Authorization behavior24232424Workload identity access tokens are backed by an OpenAI service account and project. On OpenAI API surfaces, they authorize like service-account API credentials rather than user OAuth tokens.24252426If a mapping defines permissions, those permissions further narrow the effective API access for tokens minted from that mapping. If a mapping doesn't define permissions, OpenAI doesn't add a workload identity federation-specific scope restriction, and authorization is derived from the mapped service account's project and organization roles.24272428Workload identity tokens don't bypass normal endpoint authorization. The target endpoint must still allow the effective permissions and project access carried by the token.24292430For X.509 exchanges, the bearer token replaces the API key, not the client certificate. The bearer and API mTLS certificate are verified independently. The bearer isn't certificate-bound and doesn't use DPoP or a `cnf` claim.24312432## Limitations24332434Workload identity federation currently has the following limitations:24352436- Workload identity access tokens can't be used to call Admin API endpoints. For Admin APIs, use an admin API key.2437- Each organization can create at most 50 Workload Identity Providers. Each Workload Identity Provider can have at most 50 service account mappings.2438- Workload identity access tokens aren't accepted by these endpoints: `DELETE /v1/models/{id}` and `POST /v1/images/request_audit`.2439- Arbitrary OIDC issuer endpoints other than the providers documented in the [setup guides](https://developers.openai.com/api/docs/guides/workload-identity-federation) aren't supported yet.2440- X.509 Workload Identity Providers reuse active Mutual TLS roots and don't have a separate certificate trust store.2441- X.509 certificate exchange doesn't perform certificate revocation list (CRL) or OCSP checks.2442- SPIFFE support is limited to JWT-SVID subject tokens. X.509-SVIDs aren't supported by this token exchange endpoint.