Destinations

OpenAI

Background

OpenAI is an artificial intelligence research organization dedicated to ensuring that artificial general intelligence (AGI) benefits all of humanity. Founded in December 2015, OpenAI aims to develop and promote friendly AI in a way that aligns with human values and promotes transparency and safety in AI technologies. Through cutting-edge research and innovative applications, OpenAI has produced a variety of advanced AI systems, including the widely recognized language model GPT-3, which excels in natural language processing and generation. By collaborating with numerous partners and actively engaging with the community, OpenAI strives to address the ethical and practical implications of AI, working towards a future where the transformative power of AI is harnessed responsibly and effectively.

Setup

Supported Actions

assistants

  • GETRetrieves an assistant.
  • POSTModifies an assistant.
  • DELETEDelete an assistant.
  • GETReturns a list of assistants.
  • POSTCreate an assistant with a model and instructions.

audio

  • POSTGenerates audio from the input text.
  • POSTTranscribes audio into the input language.
  • POSTTranslates audio into English.

batches

  • POSTCancels 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.
  • GETRetrieves a batch.
  • POSTCreates and executes a batch from an uploaded file of requests
  • GETList your organization's batches.

chat

  • GETGet the messages in a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.
  • GETGet a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.
  • POSTModify 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.
  • DELETEDelete a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be deleted.
  • GETList stored Chat Completions. Only Chat Completions that have been stored with the `store` parameter set to `true` will be returned.
  • POST**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).

completions

  • POSTCreates a completion for the provided prompt and parameters.

embeddings

  • POSTCreates an embedding vector representing the input text.

evals

  • GETGet an evaluation run output item by ID.
  • GETGet a list of output items for an evaluation run.
  • GETGet an evaluation run by ID.
  • POSTCancel an ongoing evaluation run.
  • DELETEDelete an eval run.
  • GETGet a list of runs for an evaluation.
  • POSTCreate a new evaluation run. This is the endpoint that will kick off grading.
  • GETGet an evaluation by ID.
  • POSTUpdate certain properties of an evaluation.
  • DELETEDelete an evaluation.
  • GETList evaluations for a project.
  • POSTCreate 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 ty

files

  • GETReturns the contents of the specified file.
  • DELETEDelete a file.
  • GETReturns information about a specific file.
  • GETReturns a list of files.
  • POSTUpload 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

fine_tuning

  • DELETE**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.
  • GET**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.
  • POST**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.
  • POSTImmediately cancel a fine-tune job.
  • GETList checkpoints for a fine-tuning job.
  • GETGet status updates for a fine-tuning job.
  • GETGet info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/fine-tuning)
  • POSTCreates 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
  • GETList your organization's fine-tuning jobs

images

  • POSTCreates 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`.
  • POSTCreates an image given a prompt. [Learn more](/docs/guides/images).
  • POSTCreates a variation of a given image. This endpoint only supports `dall-e-2`.

models

  • GETRetrieves a model instance, providing basic information about the model such as the owner and permissioning.
  • DELETEDelete a fine-tuned model. You must have the Owner role in your organization to delete a model.
  • GETLists the currently available models, and provides basic information about each one such as the owner and availability.

moderations

  • POSTClassifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation).

organization

  • GETRetrieve a single organization API key
  • DELETEDelete an organization admin API key
  • GETList organization API keys
  • POSTCreate an organization admin API key
  • GETList user actions and configuration changes within this organization.
  • POSTActivate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time.
  • POSTDeactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time.
  • GETGet a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not.
  • POSTModify a certificate. Note that only the name can be modified.
  • DELETEDelete a certificate from the organization. The certificate must be inactive for the organization and all projects.
  • GETList uploaded certificates for this organization.
  • POSTUpload a certificate to the organization. This does **not** automatically activate the certificate. Organizations can upload up to 50 certificates.
  • GETGet costs details for the organization.
  • GETRetrieves an invite.
  • DELETEDelete an invite. If the invite has already been accepted, it cannot be deleted.
  • GETReturns a list of invites in the organization.
  • POSTCreate an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
  • GETRetrieves an API key in the project.
  • DELETEDeletes an API key from the project.
  • GETReturns a list of API keys in the project.
  • POSTArchives a project in the organization. Archived projects cannot be used or updated.
  • POSTActivate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time.
  • POSTDeactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.
  • GETList certificates for this project.
  • POSTUpdates a project rate limit.
  • GETReturns the rate limits per model for a project.
  • GETRetrieves a service account in the project.
  • DELETEDeletes a service account from the project.
  • GETReturns a list of service accounts in the project.
  • POSTCreates a new service account in the project. This also returns an unredacted API key for the service account.
  • GETRetrieves a user in the project.
  • POSTModifies a user's role in the project.
  • DELETEDeletes a user from the project.
  • GETReturns a list of users in the project.
  • POSTAdds a user to the project. Users must already be members of the organization to be added to a project.
  • GETRetrieves a project.
  • POSTModifies a project in the organization.
  • GETReturns a list of projects.
  • POSTCreate a new project in the organization. Projects can be created and archived, but cannot be deleted.
  • GETGet audio speeches usage details for the organization.
  • GETGet audio transcriptions usage details for the organization.
  • GETGet code interpreter sessions usage details for the organization.
  • GETGet completions usage details for the organization.
  • GETGet embeddings usage details for the organization.
  • GETGet images usage details for the organization.
  • GETGet moderations usage details for the organization.
  • GETGet vector stores usage details for the organization.
  • GETRetrieves a user by their identifier.
  • POSTModifies a user's role in the organization.
  • DELETEDeletes a user from the organization.
  • GETLists all of the users in the organization.

realtime

  • POSTCreate 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
  • POSTCreate 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 s

responses

  • GETReturns a list of input items for a given response.
  • GETRetrieves a model response with the given ID.
  • DELETEDeletes a model response with the given ID.
  • POSTCreates 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-c

threads

  • POSTCreate a thread and run it in one request.
  • GETRetrieve a message.
  • POSTModifies a message.
  • DELETEDeletes a message.
  • GETReturns a list of messages for a given thread.
  • POSTCreate a message.
  • POSTCancels a run that is `in_progress`.
  • GETRetrieves a run step.
  • GETReturns a list of run steps belonging to a run.
  • POSTWhen 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.
  • GETRetrieves a run.
  • POSTModifies a run.
  • GETReturns a list of runs belonging to a thread.
  • POSTCreate a run.
  • GETRetrieves a thread.
  • POSTModifies a thread.
  • DELETEDelete a thread.
  • POSTCreate a thread.

uploads

  • POSTCancels the Upload. No Parts may be added after an Upload is cancelled.
  • POSTCompletes 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
  • POSTAdds 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
  • POSTCreates 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 yo

vector_stores

  • POSTCancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
  • GETReturns a list of vector store files in a batch.
  • GETRetrieves a vector store file batch.
  • POSTCreate a vector store file batch.
  • GETRetrieve the parsed contents of a vector store file.
  • GETRetrieves a vector store file.
  • DELETEDelete 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.
  • POSTUpdate attributes on a vector store file.
  • GETReturns a list of vector store files.
  • POSTCreate a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
  • POSTSearch a vector store for relevant chunks based on a query and file attributes filter.
  • GETRetrieves a vector store.
  • POSTModifies a vector store.
  • DELETEDelete a vector store.
  • GETReturns a list of vector stores.
  • POSTCreate a vector store.