OpenAI
Operations
Delete an assistant.
Retrieves an assistant.
Modifies an assistant.
Returns a list of assistants.
Create an assistant with a model and instructions.
Generates audio from the input text.
Transcribes audio into the input language.
Translates audio into English.
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.
Retrieves a batch.
List your organization's batches.
Creates and executes a batch from an uploaded file of requests
Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.
Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.
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.
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.
List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.
Starting a new project? We recommend trying Responses to take advantage of the latest OpenAI platform features. Compare Chat Completions with Responses. Creates a model response for the given chat conversation. Learn more in the text generation, vision, and 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.
Creates a completion for the provided prompt and parameters.
Creates an embedding vector representing the input text.
Delete an evaluation.
Get an evaluation by ID.
Update certain properties of an evaluation.
Get a list of runs for an evaluation.
Create a new evaluation run. This is the endpoint that will kick off grading.
Delete an eval run.
Get an evaluation run by ID.
Get a list of output items for an evaluation run.
Get an evaluation run output item by ID.
Cancel an ongoing evaluation run.
List evaluations for a project.
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 a datasource. 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.
Returns the contents of the specified file.
Delete a file.
Returns information about a specific file.
Returns a list of files.
Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. The Assistants API supports files up to 2 million tokens and of specific file types. See the Assistants Tools guide for details. The Fine-tuning API only supports .jsonl files. The input also has certain required formats for fine-tuning chat or completions models. The Batch API only supports .jsonl files up to 200 MB in size. The input also has a specific required format. Please contact us if you need to increase these storage limits.
NOTE: This endpoint requires an admin API key. Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.
NOTE: This endpoint requires an admin API key. Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.
NOTE: Calling this endpoint requires an admin API key. This enables organization owners to share fine-tuned models with other projects in their organization.
Immediately cancel a fine-tune job.
List checkpoints for a fine-tuning job.
Get status updates for a fine-tuning job.
Get info about a fine-tuning job. Learn more about fine-tuning
List your organization's fine-tuning jobs
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
Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.
Creates an image given a prompt. Learn more.
Creates a variation of a given image. This endpoint only supports dall-e-2.
Lists the currently available models, and provides basic information about each one such as the owner and availability.
Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
Classifies if text and/or image inputs are potentially harmful. Learn more in the moderation guide.
List organization API keys
Delete an organization admin API key
Retrieve a single organization API key
Create an organization admin API key
List user actions and configuration changes within this organization.
Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time.
Delete a certificate from the organization. The certificate must be inactive for the organization and all projects.
Get a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not.
Modify a certificate. Note that only the name can be modified.
Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time.
List uploaded certificates for this organization.
Upload a certificate to the organization. This does not automatically activate the certificate. Organizations can upload up to 50 certificates.
Get costs details for the organization.
Returns a list of invites in the organization.
Delete an invite. If the invite has already been accepted, it cannot be deleted.
Retrieves an invite.
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
Returns a list of projects.
Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
Returns a list of API keys in the project.
Deletes an API key from the project.
Retrieves an API key in the project.
Archives a project in the organization. Archived projects cannot be used or updated.
Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time.
Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.
List certificates for this project.
Retrieves a project.
Modifies a project in the organization.
Returns the rate limits per model for a project.
Updates a project rate limit.
Returns a list of service accounts in the project.
Creates a new service account in the project. This also returns an unredacted API key for the service account.
Deletes a service account from the project.
Retrieves a service account in the project.
Returns a list of users in the project.
Adds a user to the project. Users must already be members of the organization to be added to a project.
Deletes a user from the project.
Retrieves a user in the project.
Modifies a user's role in the project.
Get audio speeches usage details for the organization.
Get audio transcriptions usage details for the organization.
Get code interpreter sessions usage details for the organization.
Get completions usage details for the organization.
Get embeddings usage details for the organization.
Get images usage details for the organization.
Get moderations usage details for the organization.
Get vector stores usage details for the organization.
Lists all of the users in the organization.
Deletes a user from the organization.
Retrieves a user by their identifier.
Modifies a user's role in the organization.
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.
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.
Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.
Deletes a model response with the given ID.
Retrieves a model response with the given ID.
Returns a list of input items for a given response.
Create a thread.
Create a thread and run it in one request.
Delete a thread.
Retrieves a thread.
Returns a list of messages for a given thread.
Deletes a message.
Retrieve a message.
Modifies a message.
Create a message.
Modifies a thread.
Returns a list of runs belonging to a thread.
Create a run.
Cancels a run that is in_progress.
Retrieves a run.
Modifies a run.
Returns a list of run steps belonging to a run.
Retrieves a run step.
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.
Creates an intermediate Upload object that you can add Parts 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 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. For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.
Cancels the Upload. No Parts may be added after an Upload is cancelled.
Completes the Upload. Within the returned Upload object, there is a nested File 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.
Adds a Part to an Upload 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.
Returns a list of vector stores.
Create a vector store.
Delete a vector store.
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
Returns a list of vector store files in a batch.
Retrieves a vector store file batch.
Create a vector store file batch.
Retrieve the parsed contents of a vector store file.
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 endpoint.
Retrieves a vector store file.
Update attributes on a vector store file.
Returns a list of vector store files.
Create a vector store file by attaching a File to a vector store.
Retrieves a vector store.
Modifies a vector store.
Search a vector store for relevant chunks based on a query and file attributes filter.