# openai OpenAPI overview > Below is an overview of the openai openapi in simple language. This API contains 271 endpoints. For more detailed information of an endpoint, visit https://oapis.org/summary/openai/[idOrRoute] OpenAI API v2.3.0 - https://api.openai.com The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details. ## Assistants Build Assistants that can call models and use tools. - [listAssistants](https://oapis.org/openapi/openai/listAssistants): Returns a list of assistants. - [createAssistant](https://oapis.org/openapi/openai/createAssistant): Create an assistant with a model and instructions. - [getAssistant](https://oapis.org/openapi/openai/getAssistant): Retrieves an assistant. - [modifyAssistant](https://oapis.org/openapi/openai/modifyAssistant): Modifies an assistant. - [deleteAssistant](https://oapis.org/openapi/openai/deleteAssistant): Delete an assistant. - [createThread](https://oapis.org/openapi/openai/createThread): Create a thread. - [createThreadAndRun](https://oapis.org/openapi/openai/createThreadAndRun): Create a thread and run it in one request. - [getThread](https://oapis.org/openapi/openai/getThread): Retrieves a thread. - [modifyThread](https://oapis.org/openapi/openai/modifyThread): Modifies a thread. - [deleteThread](https://oapis.org/openapi/openai/deleteThread): Delete a thread. - [listMessages](https://oapis.org/openapi/openai/listMessages): Returns a list of messages for a given thread. - [createMessage](https://oapis.org/openapi/openai/createMessage): Create a message. - [getMessage](https://oapis.org/openapi/openai/getMessage): Retrieve a message. - [modifyMessage](https://oapis.org/openapi/openai/modifyMessage): Modifies a message. - [deleteMessage](https://oapis.org/openapi/openai/deleteMessage): Deletes a message. - [listRuns](https://oapis.org/openapi/openai/listRuns): Returns a list of runs belonging to a thread. - [createRun](https://oapis.org/openapi/openai/createRun): Create a run. - [getRun](https://oapis.org/openapi/openai/getRun): Retrieves a run. - [modifyRun](https://oapis.org/openapi/openai/modifyRun): Modifies a run. - [cancelRun](https://oapis.org/openapi/openai/cancelRun): Cancels a run that is `in_progress`. - [listRunSteps](https://oapis.org/openapi/openai/listRunSteps): Returns a list of run steps belonging to a run. - [getRunStep](https://oapis.org/openapi/openai/getRunStep): Retrieves a run step. - [submitToolOuputsToRun](https://oapis.org/openapi/openai/submitToolOuputsToRun): When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. ## Audio Turn audio into text or text into audio. - [createSpeech](https://oapis.org/openapi/openai/createSpeech): Generates audio from the input text. Returns the audio file content, or a stream of audio events. - [createTranscription](https://oapis.org/openapi/openai/createTranscription): Transcribes audio into the input language. Returns a transcription object in `json`, `diarized_json`, or `verbose_json` format, or a stream of transcript events. - [createTranslation](https://oapis.org/openapi/openai/createTranslation): Translates audio into English. - [listVoiceConsents](https://oapis.org/openapi/openai/listVoiceConsents): Returns a list of voice consent recordings. - [createVoiceConsent](https://oapis.org/openapi/openai/createVoiceConsent): Upload a voice consent recording. - [getVoiceConsent](https://oapis.org/openapi/openai/getVoiceConsent): Retrieves a voice consent recording. - [updateVoiceConsent](https://oapis.org/openapi/openai/updateVoiceConsent): Updates a voice consent recording (metadata only). - [deleteVoiceConsent](https://oapis.org/openapi/openai/deleteVoiceConsent): Deletes a voice consent recording. - [createVoice](https://oapis.org/openapi/openai/createVoice): Creates a custom voice. ## Audit Logs List user actions and configuration changes within this organization. - [list-audit-logs](https://oapis.org/openapi/openai/list-audit-logs): List user actions and configuration changes within this organization. ## Batch Create large batches of API requests to run asynchronously. - [listBatches](https://oapis.org/openapi/openai/listBatches): List your organization's batches. - [createBatch](https://oapis.org/openapi/openai/createBatch): Creates and executes a batch from an uploaded file of requests - [retrieveBatch](https://oapis.org/openapi/openai/retrieveBatch): Retrieves a batch. - [cancelBatch](https://oapis.org/openapi/openai/cancelBatch): Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file. ## Certificates - [listOrganizationCertificates](https://oapis.org/openapi/openai/listOrganizationCertificates): List uploaded certificates for this organization. - [uploadCertificate](https://oapis.org/openapi/openai/uploadCertificate): Upload a certificate to the organization. This does **not** automatically activate the certificate. Organizations can upload up to 50 certificates. - [activateOrganizationCertificates](https://oapis.org/openapi/openai/activateOrganizationCertificates): Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time. - [deactivateOrganizationCertificates](https://oapis.org/openapi/openai/deactivateOrganizationCertificates): Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time. - [getCertificate](https://oapis.org/openapi/openai/getCertificate): Get a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not. - [modifyCertificate](https://oapis.org/openapi/openai/modifyCertificate): Modify a certificate. Note that only the name can be modified. - [deleteCertificate](https://oapis.org/openapi/openai/deleteCertificate): Delete a certificate from the organization. The certificate must be inactive for the organization and all projects. - [listProjectCertificates](https://oapis.org/openapi/openai/listProjectCertificates): List certificates for this project. - [activateProjectCertificates](https://oapis.org/openapi/openai/activateProjectCertificates): Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time. - [deactivateProjectCertificates](https://oapis.org/openapi/openai/deactivateProjectCertificates): Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time. ## Chat Given a list of messages comprising a conversation, the model will return a response. - [listChatCompletions](https://oapis.org/openapi/openai/listChatCompletions): List stored Chat Completions. Only Chat Completions that have been stored with the `store` parameter set to `true` will be returned. - [createChatCompletion](https://oapis.org/openapi/openai/createChatCompletion): **Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses) to take advantage of the latest OpenAI platform features. Compare [Chat Completions with Responses](/docs/guides/responses-vs-chat-completions?api-mode=responses). --- Creates a model response for the given chat conversation. Learn more in the [text generation](/docs/guides/text-generation), [vision](/docs/guides/vision), and [audio](/docs/guides/audio) guides. Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, [refer to the reasoning guide](/docs/guides/reasoning). Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed. - [getChatCompletion](https://oapis.org/openapi/openai/getChatCompletion): Get a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned. - [updateChatCompletion](https://oapis.org/openapi/openai/updateChatCompletion): Modify a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be modified. Currently, the only supported modification is to update the `metadata` field. - [deleteChatCompletion](https://oapis.org/openapi/openai/deleteChatCompletion): Delete a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be deleted. - [getChatCompletionMessages](https://oapis.org/openapi/openai/getChatCompletionMessages): Get the messages in a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned. ## Completions Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. - [createCompletion](https://oapis.org/openapi/openai/createCompletion): Creates a completion for the provided prompt and parameters. Returns a completion object, or a sequence of completion objects if the request is streamed. ## Conversations Manage conversations and conversation items. - [listConversationItems](https://oapis.org/openapi/openai/listConversationItems): List all items for a conversation with the given ID. - [createConversationItems](https://oapis.org/openapi/openai/createConversationItems): Create items in a conversation with the given ID. - [getConversationItem](https://oapis.org/openapi/openai/getConversationItem): Get a single item from a conversation with the given IDs. - [deleteConversationItem](https://oapis.org/openapi/openai/deleteConversationItem): Delete an item from a conversation with the given IDs. - [createConversation](https://oapis.org/openapi/openai/createConversation): Create a conversation. - [getConversation](https://oapis.org/openapi/openai/getConversation): Get a conversation - [updateConversation](https://oapis.org/openapi/openai/updateConversation): Update a conversation - [deleteConversation](https://oapis.org/openapi/openai/deleteConversation): Delete a conversation. Items in the conversation will not be deleted. ## Data retention - [retrieve-organization-data-retention](https://oapis.org/openapi/openai/retrieve-organization-data-retention): Retrieves organization data retention controls. - [update-organization-data-retention](https://oapis.org/openapi/openai/update-organization-data-retention): Updates organization data retention controls. - [retrieve-project-data-retention](https://oapis.org/openapi/openai/retrieve-project-data-retention): Retrieves project data retention controls. - [update-project-data-retention](https://oapis.org/openapi/openai/update-project-data-retention): Updates project data retention controls. ## Embeddings Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. - [createEmbedding](https://oapis.org/openapi/openai/createEmbedding): Creates an embedding vector representing the input text. ## Evals Manage and run evals in the OpenAI platform. - [listEvals](https://oapis.org/openapi/openai/listEvals): List evaluations for a project. - [createEval](https://oapis.org/openapi/openai/createEval): Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the [Evals guide](/docs/guides/evals). - [getEval](https://oapis.org/openapi/openai/getEval): Get an evaluation by ID. - [updateEval](https://oapis.org/openapi/openai/updateEval): Update certain properties of an evaluation. - [deleteEval](https://oapis.org/openapi/openai/deleteEval): Delete an evaluation. - [getEvalRuns](https://oapis.org/openapi/openai/getEvalRuns): Get a list of runs for an evaluation. - [createEvalRun](https://oapis.org/openapi/openai/createEvalRun): Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation. - [getEvalRun](https://oapis.org/openapi/openai/getEvalRun): Get an evaluation run by ID. - [cancelEvalRun](https://oapis.org/openapi/openai/cancelEvalRun): Cancel an ongoing evaluation run. - [deleteEvalRun](https://oapis.org/openapi/openai/deleteEvalRun): Delete an eval run. - [getEvalRunOutputItems](https://oapis.org/openapi/openai/getEvalRunOutputItems): Get a list of output items for an evaluation run. - [getEvalRunOutputItem](https://oapis.org/openapi/openai/getEvalRunOutputItem): Get an evaluation run output item by ID. ## Files Files are used to upload documents that can be used with features like Assistants and Fine-tuning. - [listFiles](https://oapis.org/openapi/openai/listFiles): Returns a list of files. - [createFile](https://oapis.org/openapi/openai/createFile): Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit. Uploads to this endpoint are rate-limited to 1,000 requests per minute per authenticated user. - The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](/docs/assistants/tools) for details. - The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning [chat](/docs/api-reference/fine-tuning/chat-input) or [completions](/docs/api-reference/fine-tuning/completions-input) models. - The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a specific required [format](/docs/api-reference/batch/request-input). - For Retrieval or `file_search` ingestion, upload files here first. If you need to attach multiple uploaded files to the same vector store, use [`/vector_stores/{vector_store_id}/file_batches`](/docs/api-reference/vector-stores-file-batches/createBatch) instead of attaching them one by one. Vector store attachment has separate limits from file upload, including 2,000 attached files per minute per organization. Please [contact us](https://help.openai.com/) if you need to increase these storage limits. - [retrieveFile](https://oapis.org/openapi/openai/retrieveFile): Returns information about a specific file. - [deleteFile](https://oapis.org/openapi/openai/deleteFile): Delete a file and remove it from all vector stores. - [downloadFile](https://oapis.org/openapi/openai/downloadFile): Returns the contents of the specified file. ## Fine-tuning Manage fine-tuning jobs to tailor a model to your specific training data. - [runGrader](https://oapis.org/openapi/openai/runGrader): Run a grader. - [validateGrader](https://oapis.org/openapi/openai/validateGrader): Validate a grader. - [listFineTuningCheckpointPermissions](https://oapis.org/openapi/openai/listFineTuningCheckpointPermissions): **NOTE:** This endpoint requires an [admin API key](../admin-api-keys). Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint. - [createFineTuningCheckpointPermission](https://oapis.org/openapi/openai/createFineTuningCheckpointPermission): **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys). This enables organization owners to share fine-tuned models with other projects in their organization. - [deleteFineTuningCheckpointPermission](https://oapis.org/openapi/openai/deleteFineTuningCheckpointPermission): **NOTE:** This endpoint requires an [admin API key](../admin-api-keys). Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint. - [listPaginatedFineTuningJobs](https://oapis.org/openapi/openai/listPaginatedFineTuningJobs): List your organization's fine-tuning jobs - [createFineTuningJob](https://oapis.org/openapi/openai/createFineTuningJob): Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about fine-tuning](/docs/guides/model-optimization) - [retrieveFineTuningJob](https://oapis.org/openapi/openai/retrieveFineTuningJob): Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/model-optimization) - [cancelFineTuningJob](https://oapis.org/openapi/openai/cancelFineTuningJob): Immediately cancel a fine-tune job. - [listFineTuningJobCheckpoints](https://oapis.org/openapi/openai/listFineTuningJobCheckpoints): List checkpoints for a fine-tuning job. - [listFineTuningEvents](https://oapis.org/openapi/openai/listFineTuningEvents): Get status updates for a fine-tuning job. - [pauseFineTuningJob](https://oapis.org/openapi/openai/pauseFineTuningJob): Pause a fine-tune job. - [resumeFineTuningJob](https://oapis.org/openapi/openai/resumeFineTuningJob): Resume a fine-tune job. ## Group organization role assignments - [list-group-role-assignments](https://oapis.org/openapi/openai/list-group-role-assignments): Lists the organization roles assigned to a group within the organization. - [assign-group-role](https://oapis.org/openapi/openai/assign-group-role): Assigns an organization role to a group within the organization. - [retrieve-group-role](https://oapis.org/openapi/openai/retrieve-group-role): Retrieves an organization role assigned to a group. - [unassign-group-role](https://oapis.org/openapi/openai/unassign-group-role): Unassigns an organization role from a group within the organization. ## Group users - [list-group-users](https://oapis.org/openapi/openai/list-group-users): Lists the users assigned to a group. - [add-group-user](https://oapis.org/openapi/openai/add-group-user): Adds a user to a group. - [retrieve-group-user](https://oapis.org/openapi/openai/retrieve-group-user): Retrieves a user in a group. - [remove-group-user](https://oapis.org/openapi/openai/remove-group-user): Removes a user from a group. ## Groups - [list-groups](https://oapis.org/openapi/openai/list-groups): Lists all groups in the organization. - [create-group](https://oapis.org/openapi/openai/create-group): Creates a new group in the organization. - [retrieve-group](https://oapis.org/openapi/openai/retrieve-group): Retrieves a group. - [update-group](https://oapis.org/openapi/openai/update-group): Updates a group's information. - [delete-group](https://oapis.org/openapi/openai/delete-group): Deletes a group from the organization. ## Hosted tools - [retrieve-project-hosted-tool-permissions](https://oapis.org/openapi/openai/retrieve-project-hosted-tool-permissions): Returns hosted tool permissions for a project. - [update-project-hosted-tool-permissions](https://oapis.org/openapi/openai/update-project-hosted-tool-permissions): Updates hosted tool permissions for a project. ## Images Given a prompt and/or an input image, the model will generate a new image. - [createImageEdit](https://oapis.org/openapi/openai/createImageEdit): Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`, `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`. - [createImage](https://oapis.org/openapi/openai/createImage): Creates an image given a prompt. [Learn more](/docs/guides/images). - [createImageVariation](https://oapis.org/openapi/openai/createImageVariation): Creates a variation of a given image. This endpoint only supports `dall-e-2`. ## Invites - [list-invites](https://oapis.org/openapi/openai/list-invites): Returns a list of invites in the organization. - [inviteUser](https://oapis.org/openapi/openai/inviteUser): Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization. - [retrieve-invite](https://oapis.org/openapi/openai/retrieve-invite): Retrieves an invite. - [delete-invite](https://oapis.org/openapi/openai/delete-invite): Delete an invite. If the invite has already been accepted, it cannot be deleted. ## Models List and describe the various models available in the API. - [listModels](https://oapis.org/openapi/openai/listModels): Lists the currently available models, and provides basic information about each one such as the owner and availability. - [retrieveModel](https://oapis.org/openapi/openai/retrieveModel): Retrieves a model instance, providing basic information about the model such as the owner and permissioning. - [deleteModel](https://oapis.org/openapi/openai/deleteModel): Delete a fine-tuned model. You must have the Owner role in your organization to delete a model. ## Moderations Given text and/or image inputs, classifies if those inputs are potentially harmful. - [createModeration](https://oapis.org/openapi/openai/createModeration): Classifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation). ## Project group role assignments - [list-project-group-role-assignments](https://oapis.org/openapi/openai/list-project-group-role-assignments): Lists the project roles assigned to a group within a project. - [assign-project-group-role](https://oapis.org/openapi/openai/assign-project-group-role): Assigns a project role to a group within a project. - [retrieve-project-group-role](https://oapis.org/openapi/openai/retrieve-project-group-role): Retrieves a project role assigned to a group. - [unassign-project-group-role](https://oapis.org/openapi/openai/unassign-project-group-role): Unassigns a project role from a group within a project. ## Project groups - [list-project-groups](https://oapis.org/openapi/openai/list-project-groups): Lists the groups that have access to a project. - [add-project-group](https://oapis.org/openapi/openai/add-project-group): Grants a group access to a project. - [retrieve-project-group](https://oapis.org/openapi/openai/retrieve-project-group): Retrieves a project's group. - [remove-project-group](https://oapis.org/openapi/openai/remove-project-group): Revokes a group's access to a project. ## Project user role assignments - [list-project-user-role-assignments](https://oapis.org/openapi/openai/list-project-user-role-assignments): Lists the project roles assigned to a user within a project. - [assign-project-user-role](https://oapis.org/openapi/openai/assign-project-user-role): Assigns a project role to a user within a project. - [retrieve-project-user-role](https://oapis.org/openapi/openai/retrieve-project-user-role): Retrieves a project role assigned to a user. - [unassign-project-user-role](https://oapis.org/openapi/openai/unassign-project-user-role): Unassigns a project role from a user within a project. ## Projects - [list-projects](https://oapis.org/openapi/openai/list-projects): Returns a list of projects. - [create-project](https://oapis.org/openapi/openai/create-project): Create a new project in the organization. Projects can be created and archived, but cannot be deleted. - [retrieve-project](https://oapis.org/openapi/openai/retrieve-project): Retrieves a project. - [modify-project](https://oapis.org/openapi/openai/modify-project): Modifies a project in the organization. - [list-project-api-keys](https://oapis.org/openapi/openai/list-project-api-keys): Returns a list of API keys in the project. - [retrieve-project-api-key](https://oapis.org/openapi/openai/retrieve-project-api-key): Retrieves an API key in the project. - [delete-project-api-key](https://oapis.org/openapi/openai/delete-project-api-key): Deletes an API key from the project. Returns confirmation of the key deletion, or an error if the key belonged to a service account. - [archive-project](https://oapis.org/openapi/openai/archive-project): Archives a project in the organization. Archived projects cannot be used or updated. - [retrieve-project-model-permissions](https://oapis.org/openapi/openai/retrieve-project-model-permissions): Returns model permissions for a project. - [update-project-model-permissions](https://oapis.org/openapi/openai/update-project-model-permissions): Updates model permissions for a project. - [delete-project-model-permissions](https://oapis.org/openapi/openai/delete-project-model-permissions): Deletes model permissions for a project. - [list-project-rate-limits](https://oapis.org/openapi/openai/list-project-rate-limits): Returns the rate limits per model for a project. - [update-project-rate-limits](https://oapis.org/openapi/openai/update-project-rate-limits): Updates a project rate limit. - [list-project-service-accounts](https://oapis.org/openapi/openai/list-project-service-accounts): Returns a list of service accounts in the project. - [create-project-service-account](https://oapis.org/openapi/openai/create-project-service-account): Creates a new service account in the project. This also returns an unredacted API key for the service account. - [retrieve-project-service-account](https://oapis.org/openapi/openai/retrieve-project-service-account): Retrieves a service account in the project. - [update-project-service-account](https://oapis.org/openapi/openai/update-project-service-account): Updates a service account in the project. - [delete-project-service-account](https://oapis.org/openapi/openai/delete-project-service-account): Deletes a service account from the project. Returns confirmation of service account deletion, or an error if the project is archived (archived projects have no service accounts). - [list-project-users](https://oapis.org/openapi/openai/list-project-users): Returns a list of users in the project. - [create-project-user](https://oapis.org/openapi/openai/create-project-user): Adds a user to the project. Users must already be members of the organization to be added to a project. - [retrieve-project-user](https://oapis.org/openapi/openai/retrieve-project-user): Retrieves a user in the project. - [modify-project-user](https://oapis.org/openapi/openai/modify-project-user): Modifies a user's role in the project. - [delete-project-user](https://oapis.org/openapi/openai/delete-project-user): Deletes a user from the project. Returns confirmation of project user deletion, or an error if the project is archived (archived projects have no users). ## Realtime - [create-realtime-call](https://oapis.org/openapi/openai/create-realtime-call): Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection. - [accept-realtime-call](https://oapis.org/openapi/openai/accept-realtime-call): Accept an incoming SIP call and configure the realtime session that will handle it. - [hangup-realtime-call](https://oapis.org/openapi/openai/hangup-realtime-call): End an active Realtime API call, whether it was initiated over SIP or WebRTC. - [refer-realtime-call](https://oapis.org/openapi/openai/refer-realtime-call): Transfer an active SIP call to a new destination using the SIP REFER verb. - [reject-realtime-call](https://oapis.org/openapi/openai/reject-realtime-call): Decline an incoming SIP call by returning a SIP status code to the caller. - [create-realtime-client-secret](https://oapis.org/openapi/openai/create-realtime-client-secret): Create a Realtime client secret with an associated session configuration. Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime API without leaking your main API key. You can configure a custom TTL for each client secret. You can also attach session configuration options to the client secret, which will be applied to any sessions created using that client secret, but these can also be overridden by the client connection. [Learn more about authentication with client secrets over WebRTC](/docs/guides/realtime-webrtc). Returns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`. - [create-realtime-session](https://oapis.org/openapi/openai/create-realtime-session): Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the `session.update` client event. It responds with a session object, plus a `client_secret` key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API. Returns the created Realtime session object, plus an ephemeral key. - [create-realtime-transcription-session](https://oapis.org/openapi/openai/create-realtime-transcription-session): Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the `transcription_session.update` client event. It responds with a session object, plus a `client_secret` key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API. Returns the created Realtime transcription session object, plus an ephemeral key. - [create-realtime-translation-client-secret](https://oapis.org/openapi/openai/create-realtime-translation-client-secret): Create a Realtime translation client secret with an associated translation session configuration. Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime Translation API without leaking your main API key. You can configure a custom TTL for each client secret. Returns the created client secret and the effective translation session object. The client secret is a string that looks like `ek_1234`. ## Responses - [createResponse](https://oapis.org/openapi/openai/createResponse): Creates a model response. Provide [text](/docs/guides/text) or [image](/docs/guides/images) inputs to generate [text](/docs/guides/text) or [JSON](/docs/guides/structured-outputs) outputs. Have the model call your own [custom code](/docs/guides/function-calling) or use built-in [tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search) or [file search](/docs/guides/tools-file-search) to use your own data as input for the model's response. - [getResponse](https://oapis.org/openapi/openai/getResponse): Retrieves a model response with the given ID. - [deleteResponse](https://oapis.org/openapi/openai/deleteResponse): Deletes a model response with the given ID. - [cancelResponse](https://oapis.org/openapi/openai/cancelResponse): Cancels a model response with the given ID. Only responses created with the `background` parameter set to `true` can be cancelled. [Learn more](/docs/guides/background). - [listInputItems](https://oapis.org/openapi/openai/listInputItems): Returns a list of input items for a given response. ## Roles - [list-roles](https://oapis.org/openapi/openai/list-roles): Lists the roles configured for the organization. - [create-role](https://oapis.org/openapi/openai/create-role): Creates a custom role for the organization. - [retrieve-role](https://oapis.org/openapi/openai/retrieve-role): Retrieves an organization role. - [update-role](https://oapis.org/openapi/openai/update-role): Updates an existing organization role. - [delete-role](https://oapis.org/openapi/openai/delete-role): Deletes a custom role from the organization. - [list-project-roles](https://oapis.org/openapi/openai/list-project-roles): Lists the roles configured for a project. - [create-project-role](https://oapis.org/openapi/openai/create-project-role): Creates a custom role for a project. - [retrieve-project-role](https://oapis.org/openapi/openai/retrieve-project-role): Retrieves a project role. - [update-project-role](https://oapis.org/openapi/openai/update-project-role): Updates an existing project role. - [delete-project-role](https://oapis.org/openapi/openai/delete-project-role): Deletes a custom role from a project. ## Skills - [ListSkills](https://oapis.org/openapi/openai/ListSkills): List all skills for the current project. - [CreateSkill](https://oapis.org/openapi/openai/CreateSkill): Create a new skill. - [GetSkill](https://oapis.org/openapi/openai/GetSkill): Get a skill by its ID. - [UpdateSkillDefaultVersion](https://oapis.org/openapi/openai/UpdateSkillDefaultVersion): Update the default version pointer for a skill. - [DeleteSkill](https://oapis.org/openapi/openai/DeleteSkill): Delete a skill by its ID. - [GetSkillContent](https://oapis.org/openapi/openai/GetSkillContent): Download a skill zip bundle by its ID. - [ListSkillVersions](https://oapis.org/openapi/openai/ListSkillVersions): List skill versions for a skill. - [CreateSkillVersion](https://oapis.org/openapi/openai/CreateSkillVersion): Create a new immutable skill version. - [GetSkillVersion](https://oapis.org/openapi/openai/GetSkillVersion): Get a specific skill version. - [DeleteSkillVersion](https://oapis.org/openapi/openai/DeleteSkillVersion): Delete a skill version. - [GetSkillVersionContent](https://oapis.org/openapi/openai/GetSkillVersionContent): Download a skill version zip bundle. ## Spend alerts - [list-project-spend-alerts](https://oapis.org/openapi/openai/list-project-spend-alerts): Lists project spend alerts. - [create-project-spend-alert](https://oapis.org/openapi/openai/create-project-spend-alert): Creates a project spend alert. - [update-project-spend-alert](https://oapis.org/openapi/openai/update-project-spend-alert): Updates a project spend alert. - [delete-project-spend-alert](https://oapis.org/openapi/openai/delete-project-spend-alert): Deletes a project spend alert. - [list-organization-spend-alerts](https://oapis.org/openapi/openai/list-organization-spend-alerts): Lists organization spend alerts. - [create-organization-spend-alert](https://oapis.org/openapi/openai/create-organization-spend-alert): Creates an organization spend alert. - [update-organization-spend-alert](https://oapis.org/openapi/openai/update-organization-spend-alert): Updates an organization spend alert. - [delete-organization-spend-alert](https://oapis.org/openapi/openai/delete-organization-spend-alert): Deletes an organization spend alert. ## Uploads Use Uploads to upload large files in multiple parts. - [createUpload](https://oapis.org/openapi/openai/createUpload): Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. Once you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object. For certain `purpose` values, the correct `mime_type` must be specified. Please refer to documentation for the [supported MIME types for your use case](/docs/assistants/tools/file-search#supported-files). For guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create). Returns the Upload object with status `pending`. - [cancelUpload](https://oapis.org/openapi/openai/cancelUpload): Cancels the Upload. No Parts may be added after an Upload is cancelled. Returns the Upload object with status `cancelled`. - [completeUpload](https://oapis.org/openapi/openai/completeUpload): Completes the [Upload](/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform. You can specify the order of the Parts by passing in an ordered list of the Part IDs. The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object. - [addUploadPart](https://oapis.org/openapi/openai/addUploadPart): Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete). ## Usage - [usage-costs](https://oapis.org/openapi/openai/usage-costs): Get costs details for the organization. - [usage-audio-speeches](https://oapis.org/openapi/openai/usage-audio-speeches): Get audio speeches usage details for the organization. - [usage-audio-transcriptions](https://oapis.org/openapi/openai/usage-audio-transcriptions): Get audio transcriptions usage details for the organization. - [usage-code-interpreter-sessions](https://oapis.org/openapi/openai/usage-code-interpreter-sessions): Get code interpreter sessions usage details for the organization. - [usage-completions](https://oapis.org/openapi/openai/usage-completions): Get completions usage details for the organization. - [usage-embeddings](https://oapis.org/openapi/openai/usage-embeddings): Get embeddings usage details for the organization. - [usage-file-search-calls](https://oapis.org/openapi/openai/usage-file-search-calls): Get file search calls usage details for the organization. - [usage-images](https://oapis.org/openapi/openai/usage-images): Get images usage details for the organization. - [usage-moderations](https://oapis.org/openapi/openai/usage-moderations): Get moderations usage details for the organization. - [usage-vector-stores](https://oapis.org/openapi/openai/usage-vector-stores): Get vector stores usage details for the organization. - [usage-web-search-calls](https://oapis.org/openapi/openai/usage-web-search-calls): Get web search calls usage details for the organization. ## User organization role assignments - [list-user-role-assignments](https://oapis.org/openapi/openai/list-user-role-assignments): Lists the organization roles assigned to a user within the organization. - [assign-user-role](https://oapis.org/openapi/openai/assign-user-role): Assigns an organization role to a user within the organization. - [retrieve-user-role](https://oapis.org/openapi/openai/retrieve-user-role): Retrieves an organization role assigned to a user. - [unassign-user-role](https://oapis.org/openapi/openai/unassign-user-role): Unassigns an organization role from a user within the organization. ## Users - [list-users](https://oapis.org/openapi/openai/list-users): Lists all of the users in the organization. - [retrieve-user](https://oapis.org/openapi/openai/retrieve-user): Retrieves a user by their identifier. - [modify-user](https://oapis.org/openapi/openai/modify-user): Modifies a user's role in the organization. - [delete-user](https://oapis.org/openapi/openai/delete-user): Deletes a user from the organization. ## Vector stores - [listVectorStores](https://oapis.org/openapi/openai/listVectorStores): Returns a list of vector stores. - [createVectorStore](https://oapis.org/openapi/openai/createVectorStore): Create a vector store. - [getVectorStore](https://oapis.org/openapi/openai/getVectorStore): Retrieves a vector store. - [modifyVectorStore](https://oapis.org/openapi/openai/modifyVectorStore): Modifies a vector store. - [deleteVectorStore](https://oapis.org/openapi/openai/deleteVectorStore): Delete a vector store. - [createVectorStoreFileBatch](https://oapis.org/openapi/openai/createVectorStoreFileBatch): Create a vector store file batch. - [getVectorStoreFileBatch](https://oapis.org/openapi/openai/getVectorStoreFileBatch): Retrieves a vector store file batch. - [cancelVectorStoreFileBatch](https://oapis.org/openapi/openai/cancelVectorStoreFileBatch): Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. - [listFilesInVectorStoreBatch](https://oapis.org/openapi/openai/listFilesInVectorStoreBatch): Returns a list of vector store files in a batch. - [listVectorStoreFiles](https://oapis.org/openapi/openai/listVectorStoreFiles): Returns a list of vector store files. - [createVectorStoreFile](https://oapis.org/openapi/openai/createVectorStoreFile): Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object). - [getVectorStoreFile](https://oapis.org/openapi/openai/getVectorStoreFile): Retrieves a vector store file. - [updateVectorStoreFileAttributes](https://oapis.org/openapi/openai/updateVectorStoreFileAttributes): Update attributes on a vector store file. - [deleteVectorStoreFile](https://oapis.org/openapi/openai/deleteVectorStoreFile): Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint. - [retrieveVectorStoreFileContent](https://oapis.org/openapi/openai/retrieveVectorStoreFileContent): Retrieve the parsed contents of a vector store file. - [searchVectorStore](https://oapis.org/openapi/openai/searchVectorStore): Search a vector store for relevant chunks based on a query and file attributes filter. ## Videos - [ListVideos](https://oapis.org/openapi/openai/ListVideos): List recently generated videos for the current project. - [createVideo](https://oapis.org/openapi/openai/createVideo): Create a new video generation job from a prompt and optional reference assets. - [CreateVideoCharacter](https://oapis.org/openapi/openai/CreateVideoCharacter): Create a character from an uploaded video. - [GetVideoCharacter](https://oapis.org/openapi/openai/GetVideoCharacter): Fetch a character. - [CreateVideoEdit](https://oapis.org/openapi/openai/CreateVideoEdit): Create a new video generation job by editing a source video or existing generated video. - [CreateVideoExtend](https://oapis.org/openapi/openai/CreateVideoExtend): Create an extension of a completed video. - [GetVideo](https://oapis.org/openapi/openai/GetVideo): Fetch the latest metadata for a generated video. - [DeleteVideo](https://oapis.org/openapi/openai/DeleteVideo): Permanently delete a completed or failed video and its stored assets. - [RetrieveVideoContent](https://oapis.org/openapi/openai/RetrieveVideoContent): Download the generated video bytes or a derived preview asset. Streams the rendered video content for the specified video job. - [CreateVideoRemix](https://oapis.org/openapi/openai/CreateVideoRemix): Create a remix of a completed video using a refreshed prompt. ## Other - [ListContainers](https://oapis.org/openapi/openai/ListContainers): List Containers - [CreateContainer](https://oapis.org/openapi/openai/CreateContainer): Create Container - [RetrieveContainer](https://oapis.org/openapi/openai/RetrieveContainer): Retrieve Container - [DeleteContainer](https://oapis.org/openapi/openai/DeleteContainer): Delete Container - [ListContainerFiles](https://oapis.org/openapi/openai/ListContainerFiles): List Container files - [CreateContainerFile](https://oapis.org/openapi/openai/CreateContainerFile): Create a Container File You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID. - [RetrieveContainerFile](https://oapis.org/openapi/openai/RetrieveContainerFile): Retrieve Container File - [DeleteContainerFile](https://oapis.org/openapi/openai/DeleteContainerFile): Delete Container File - [RetrieveContainerFileContent](https://oapis.org/openapi/openai/RetrieveContainerFileContent): Retrieve Container File Content - [admin-api-keys-list](https://oapis.org/openapi/openai/admin-api-keys-list): List organization API keys - [admin-api-keys-create](https://oapis.org/openapi/openai/admin-api-keys-create): Create an organization admin API key - [admin-api-keys-get](https://oapis.org/openapi/openai/admin-api-keys-get): Retrieve a single organization API key - [admin-api-keys-delete](https://oapis.org/openapi/openai/admin-api-keys-delete): Delete an organization admin API key - [Getinputtokencounts](https://oapis.org/openapi/openai/Getinputtokencounts): Returns input token counts of the request. Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count. - [Compactconversation](https://oapis.org/openapi/openai/Compactconversation): Compact a conversation. Returns a compacted response object. Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](/docs/guides/conversation-state#compaction-advanced). - [CancelChatSessionMethod](https://oapis.org/openapi/openai/CancelChatSessionMethod): Cancel an active ChatKit session and return its most recent metadata. Cancelling prevents new requests from using the issued client secret. - [CreateChatSessionMethod](https://oapis.org/openapi/openai/CreateChatSessionMethod): Create a ChatKit session. - [ListThreadItemsMethod](https://oapis.org/openapi/openai/ListThreadItemsMethod): List items that belong to a ChatKit thread. - [GetThreadMethod](https://oapis.org/openapi/openai/GetThreadMethod): Retrieve a ChatKit thread by its identifier. - [DeleteThreadMethod](https://oapis.org/openapi/openai/DeleteThreadMethod): Delete a ChatKit thread along with its items and stored attachments. - [ListThreadsMethod](https://oapis.org/openapi/openai/ListThreadsMethod): List ChatKit threads with optional pagination and user filters.