Connectors
AI, LLM & Vector Stores
OpenAI
GPT models: chat completions, embeddings, images, and audio generation
OpenAI API referenceAPI checked August 18, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 305
- Ready-made triggers
- 0
Connect OpenAI
- In Neblex open Connect › Connections and click New Connection.
- Search for OpenAI and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| API keyRequiredSecret | OpenAI API key. Organization administration operations require a key with the corresponding admin permissions. |
Use it in a flow
- Open a flow, open the node library and search for OpenAI.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
305 operations in 37 groups. Each one is a step you can add to a flow.
Assistants23
Cancels a run that is `in_progress`.cancelRun | POST | Cancels a run that is in progress. |
Create a message.createMessage | POST | Create a message. |
Create a run.createRun | POST | Create a run. |
Create a thread and run it in one request.createThreadAndRun | POST | Create a thread and run it in one request. |
Create a thread.createThread | POST | Create a thread. |
Create an assistant with a model and instructions.createAssistant | POST | Create an assistant with a model and instructions. |
Delete a thread.deleteThread | DELETE | Delete a thread. |
Delete an assistant.deleteAssistant | DELETE | Delete an assistant. |
Deletes a message.deleteMessage | DELETE | Deletes a message. |
Modifies a message.modifyMessage | POST | Modifies a message. |
Modifies a run.modifyRun | POST | Modifies a run. |
Modifies a thread.modifyThread | POST | Modifies a thread. |
Modifies an assistant.modifyAssistant | POST | Modifies an assistant. |
Retrieve a message.getMessage | GET | Retrieve a message. |
Retrieves a run step.getRunStep | GET | Retrieves a run step. |
Retrieves a run.getRun | GET | Retrieves a run. |
Retrieves a thread.getThread | GET | Retrieves a thread. |
Retrieves an assistant.getAssistant | GET | Retrieves an assistant. |
Returns a list of assistants.listAssistants | GET | Returns a list of assistants. |
Returns a list of messages for a given thread.listMessages | GET | Returns a list of messages for a given thread. |
Returns a list of run steps belonging to a run.listRunSteps | GET | Returns a list of run steps belonging to a run. |
Returns a list of runs belonging to a thread.listRuns | GET | Returns a list of runs belonging to a thread. |
When a run has the `status: "requires_action"` and `required_actionsubmitToolOuputsToRun | POST | 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. |
Audio11
Creates a custom voice.createVoice | POST | Create a custom voice you can use for audio output (for example, in Text-to-Speech and the Realtime API). |
Deletes a voice consent recording.deleteVoiceConsent | DELETE | Delete a consent recording that was uploaded for creating custom voices. |
Generates audio from the input text.
Returns the audio file content, or a stream of audio events.
createSpeech | POST | Generates audio from the input text. |
Generates audio from the input text.
Returns the audio file content, or a stream of audio events.
(exact SSE bytes)createSpeechStream | POST | Generates audio from the input text. |
Retrieves a voice consent recording.getVoiceConsent | GET | Retrieve consent recording metadata used for creating custom voices. |
Returns a list of voice consent recordings.listVoiceConsents | GET | List consent recordings available to your organization for creating custom voices. |
Transcribes audio into the input language.
Returns a transcription object in `json`, `diarized_json`, or `verbose_json`createTranscription | POST | Transcribes audio into the input language. |
Transcribes audio into the input language.
Returns a transcription object in `json`, `diarized_json`, or `verbose_json` (exact SSE bytes)createTranscriptionStream | POST | Transcribes audio into the input language. |
Translates audio into English.createTranslation | POST | Translates audio into English. |
Updates a voice consent recording (metadata only).updateVoiceConsent | POST | Update consent recording metadata used for creating custom voices. |
Upload a voice consent recording.createVoiceConsent | POST | Upload a consent recording that authorizes creation of a custom voice. |
Audit Logs1
List user actions and configuration changes within this organization.list_audit_logs | GET | List user actions and configuration changes within this organization. |
Batch4
Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancellcancelBatch | POST | Cancels an in-progress batch. |
Creates and executes a batch from an uploaded file of requestscreateBatch | POST | Creates and executes a batch from an uploaded file of requests |
List your organization's batches.listBatches | GET | List your organization's batches. |
Retrieves a batch.retrieveBatch | GET | Retrieves a batch. |
Certificates10
Activate certificates at the organization level.
You can atomically and idempotently activate up to 10 certificates at activateOrganizationCertificates | POST | Activate certificates at the organization level. |
Activate certificates at the project level.
You can atomically and idempotently activate up to 10 certificates at a timactivateProjectCertificates | POST | Activate certificates at the project level. |
Deactivate certificates at the organization level.
You can atomically and idempotently deactivate up to 10 certificatesdeactivateOrganizationCertificates | POST | Deactivate certificates at the organization level. |
Deactivate certificates at the project level. You can atomically and
idempotently deactivate up to 10 certificates at adeactivateProjectCertificates | POST | Deactivate certificates at the project level. |
Delete a certificate from the organization.
The certificate must be inactive for the organization and all projects.
deleteCertificate | DELETE | Delete a certificate from the organization. |
Get a certificate that has been uploaded to the organization.
You can get a certificate regardless of whether it is actgetCertificate | GET | Get a certificate that has been uploaded to the organization. |
List certificates for this project.listProjectCertificates | GET | List certificates for this project. |
List uploaded certificates for this organization.listOrganizationCertificates | GET | List uploaded certificates for this organization. |
Modify a certificate. Note that only the name can be modified.
modifyCertificate | POST | Modify a certificate. |
Upload a certificate to the organization. This does **not** automatically activate the certificate.
Organizations can uuploadCertificate | POST | Upload a certificate to the organization. |
Chat7
**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses)
to take advantage of the latecreateChatCompletion | POST | Starting a new project? |
**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses)
to take advantage of the late (exact SSE bytes)createChatCompletionStream | POST | Starting a new project? |
Delete a stored chat completion. Only Chat Completions that have been
created with the `store` parameter set to `true` cdeleteChatCompletion | DELETE | Delete a stored chat completion. |
Get a stored chat completion. Only Chat Completions that have been created
with the `store` parameter set to `true` willgetChatCompletion | GET | Get a stored chat completion. |
Get the messages in a stored chat completion. Only Chat Completions that
have been created with the `store` parameter segetChatCompletionMessages | GET | Get the messages in a stored chat completion. |
List stored Chat Completions. Only Chat Completions that have been stored
with the `store` parameter set to `true` will listChatCompletions | GET | List stored Chat Completions. |
Modify a stored chat completion. Only Chat Completions that have been
created with the `store` parameter set to `true` cupdateChatCompletion | POST | Modify a stored chat completion. |
Completions1
Creates a completion for the provided prompt and parameters.
Returns a completion object, or a sequence of completion ocreateCompletion | POST | Creates a completion for the provided prompt and parameters. |
Conversations8
Create a conversation.createConversation | POST | Create a conversation. |
Create items in a conversation with the given ID.createConversationItems | POST | Create items in a conversation with the given ID. |
Delete a conversation. Items in the conversation will not be deleted.deleteConversation | DELETE | Delete a conversation. |
Delete an item from a conversation with the given IDs.deleteConversationItem | DELETE | Delete an item from a conversation with the given IDs. |
Get a conversationgetConversation | GET | Get a conversation |
Get a single item from a conversation with the given IDs.getConversationItem | GET | Get a single item from a conversation with the given IDs. |
List all items for a conversation with the given ID.listConversationItems | GET | List all items for a conversation with the given ID. |
Update a conversationupdateConversation | POST | Update a conversation |
Data retention4
Retrieves organization data retention controls.retrieve_organization_data_retention | GET | Retrieves organization data retention controls. |
Retrieves project data retention controls.retrieve_project_data_retention | GET | Retrieves project data retention controls. |
Updates organization data retention controls.update_organization_data_retention | POST | Updates organization data retention controls. |
Updates project data retention controls.update_project_data_retention | POST | Updates project data retention controls. |
Embeddings1
Creates an embedding vector representing the input text.createEmbedding | POST | Creates an embedding vector representing the input text. |
Evals12
Cancel an ongoing evaluation run.
cancelEvalRun | POST | Cancel an ongoing evaluation run. |
Create the structure of an evaluation that can be used to test a model's performance.
An evaluation is a set of testing createEval | POST | Create the structure of an evaluation that can be used to test a model's performance. |
Delete an eval run.
deleteEvalRun | DELETE | Delete an eval run. |
Delete an evaluation.
deleteEval | DELETE | Delete an evaluation. |
Get a list of output items for an evaluation run.
getEvalRunOutputItems | GET | Get a list of output items for an evaluation run. |
Get a list of runs for an evaluation.
getEvalRuns | GET | Get a list of runs for an evaluation. |
Get an evaluation by ID.
getEval | GET | Get an evaluation by ID. |
Get an evaluation run by ID.
getEvalRun | GET | Get an evaluation run by ID. |
Get an evaluation run output item by ID.
getEvalRunOutputItem | GET | Get an evaluation run output item by ID. |
Kicks off a new run for a given evaluation, specifying the data source…createEvalRun | POST | Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. |
List evaluations for a project.
listEvals | GET | List evaluations for a project. |
Update certain properties of an evaluation.
updateEval | POST | Update certain properties of an evaluation. |
Files5
Delete a file and remove it from all vector stores.deleteFile | DELETE | Delete a file and remove it from all vector stores. |
Returns a list of files.listFiles | GET | Returns a list of files. |
Returns a response containing the contents of the specified file.downloadFile | GET | Returns a response containing the contents of the specified file. |
Returns information about a specific file.retrieveFile | GET | Returns information about a specific file. |
Upload a file that can be used across various endpoints. Individual files
can be up to 512 MB, and each project can storcreateFile | POST | Upload a file that can be used across various endpoints. |
Fine-tuning13
**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
This enables organization owners to shacreateFineTuningCheckpointPermission | POST | NOTE: Calling this endpoint requires an admin API key. |
**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
Organization owners can use this endpoint to dedeleteFineTuningCheckpointPermission | DELETE | NOTE: This endpoint requires an admin API key. |
**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
Organization owners can use this endpoint to vilistFineTuningCheckpointPermissions | GET | NOTE: This endpoint requires an admin API key. |
Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
Response includes detacreateFineTuningJob | POST | Creates a fine-tuning job which begins the process of creating a new model from a given dataset. |
Get info about a fine-tuning job.
[Learn more about fine-tuning](/docs/guides/model-optimization)
retrieveFineTuningJob | GET | Get info about a fine-tuning job. |
Get status updates for a fine-tuning job.
listFineTuningEvents | GET | Get status updates for a fine-tuning job. |
Immediately cancel a fine-tune job.
cancelFineTuningJob | POST | Immediately cancel a fine-tune job. |
List checkpoints for a fine-tuning job.
listFineTuningJobCheckpoints | GET | List checkpoints for a fine-tuning job. |
List your organization's fine-tuning jobs
listPaginatedFineTuningJobs | GET | List your organization's fine-tuning jobs |
Pause a fine-tune job.
pauseFineTuningJob | POST | Pause a fine-tune job. |
Resume a fine-tune job.
resumeFineTuningJob | POST | Resume a fine-tune job. |
Run a grader.
runGrader | POST | Run a grader. |
Validate a grader.
validateGrader | POST | Validate a grader. |
Group organization role assignments4
Assigns an organization role to a group within the organization.assign_group_role | POST | Assigns an organization role to a group within the organization. |
Lists the organization roles assigned to a group within the organization.list_group_role_assignments | GET | Lists the organization roles assigned to a group within the organization. |
Retrieves an organization role assigned to a group.retrieve_group_role | GET | Retrieves an organization role assigned to a group. |
Unassigns an organization role from a group within the organization.unassign_group_role | DELETE | Unassigns an organization role from a group within the organization. |
Group users4
Adds a user to a group.add_group_user | POST | Adds a user to a group. |
Lists the users assigned to a group.list_group_users | GET | Lists the users assigned to a group. |
Removes a user from a group.remove_group_user | DELETE | Removes a user from a group. |
Retrieves a user in a group.retrieve_group_user | GET | Retrieves a user in a group. |
Groups5
Creates a new group in the organization.create_group | POST | Creates a new group in the organization. |
Deletes a group from the organization.delete_group | DELETE | Deletes a group from the organization. |
Lists all groups in the organization.list_groups | GET | Lists all groups in the organization. |
Retrieves a group.retrieve_group | GET | Retrieves a group. |
Updates a group's information.update_group | POST | Updates a group's information. |
Hosted tools2
Returns hosted tool permissions for a project.retrieve_project_hosted_tool_permissions | GET | Returns hosted tool permissions for a project. |
Updates hosted tool permissions for a project.update_project_hosted_tool_permissions | POST | Updates hosted tool permissions for a project. |
Images7
Creates a variation of a given image. This endpoint only supports `dall-e-2`.createImageVariation | POST | Creates a variation of a given image. |
Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image modelcreateImageEdit | POST | You can call this endpoint with either: - multipart/form-data: use binary uploads via image (and optional mask). |
Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image modelcreateImageEdit__multipart | POST | You can call this endpoint with either: - multipart/form-data: use binary uploads via image (and optional mask). |
Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image model (exact SSE bytes)createImageEditStream | POST | You can call this endpoint with either: - multipart/form-data: use binary uploads via image (and optional mask). |
Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image model (exact SSE bytes)createImageEdit__multipartStream | POST | You can call this endpoint with either: - multipart/form-data: use binary uploads via image (and optional mask). |
Creates an image given a prompt. [Learn more](/docs/guides/images).
createImage | POST | Creates an image given a prompt. |
Creates an image given a prompt. [Learn more](/docs/guides/images).
(exact SSE bytes)createImageStream | POST | Creates an image given a prompt. |
Invites4
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the inviteUser | POST | Create an invite for a user to the organization. |
Delete an invite. If the invite has already been accepted, it cannot be deleted.delete_invite | DELETE | Delete an invite. |
Retrieves an invite.retrieve_invite | GET | Retrieves an invite. |
Returns a list of invites in the organization.list_invites | GET | Returns a list of invites in the organization. |
Models3
Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.deleteModel | DELETE | Delete a fine-tuned model. |
Lists the currently available models, and provides basic information about each one such as the owner and availability.listModels | GET | Lists the currently available models, and provides basic information about each one such as the owner and availability. |
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.retrieveModel | GET | Retrieves a model instance, providing basic information about the model such as the owner and permissioning. |
Moderations1
Classifies if text and/or image inputs are potentially harmful. Learn
more in the [moderation guide](/docs/guides/moderacreateModeration | POST | Classifies if text and/or image inputs are potentially harmful. |
OpenAI32
Cancel an active ChatKit session and return its most recent metadata.
Cancelling prevents new requests from using the iCancelChatSessionMethod | POST | Cancel an active ChatKit session and return its most recent metadata. |
Check whether an image or audio file contains known OpenAI provenance signals. [Learn more about content provenance](/apCreatecontentprovenancecheck | POST | Check whether an image or audio file contains known OpenAI provenance signals. |
Compact a conversation. Returns a compacted response object.
Learn when and how to compact long-running conversations iCompactconversation | POST | Compact a conversation. |
Compact a conversation. Returns a compacted response object.
Learn when and how to compact long-running conversations ibeta_Compactconversation | POST | Compact a conversation. |
Create a ChatKit session.CreateChatSessionMethod | POST | Create a ChatKit session. |
Create a Container File
You can send either a multipart/form-data request with the raw file content, or a JSON request CreateContainerFile | POST | Creates a container file. |
Create a Container File
You can send either a multipart/form-data request with the raw file content, or a JSON request CreateContainerFile__multipart | POST | Creates a container file. |
Create an organization admin API keyadmin_api_keys_create | POST | Create a new admin-level API key for the organization. |
Create ContainerCreateContainer | POST | Creates a container. |
Create or replace a project's hard spend limit.Updateprojectspendlimit | POST | Create or replace a project's hard spend limit. |
Create or replace the organization's hard spend limit.Updateorganizationspendlimit | POST | Create or replace the organization's hard spend limit. |
Creates an API key for a service account in the project.CreateanAPIkeyforaserviceaccount | POST | Creates an API key for a service account in the project. |
Delete a ChatKit thread along with its items and stored attachments.DeleteThreadMethod | DELETE | Delete a ChatKit thread along with its items and stored attachments. |
Delete a project's hard spend limit.Deleteprojectspendlimit | DELETE | Delete a project's hard spend limit. |
Delete an organization admin API keyadmin_api_keys_delete | DELETE | Delete the specified admin API key. |
Delete ContainerDeleteContainer | DELETE | Delete a container. |
Delete Container FileDeleteContainerFile | DELETE | Delete a container file. |
Delete the organization's hard spend limit.Deleteorganizationspendlimit | DELETE | Delete the organization's hard spend limit. |
Get a project's hard spend limit.Getprojectspendlimit | GET | Get a project's hard spend limit. |
Get the organization's hard spend limit.Getorganizationspendlimit | GET | Get the organization's hard spend limit. |
List ChatKit threads with optional pagination and user filters.ListThreadsMethod | GET | List ChatKit threads with optional pagination and user filters. |
List Container filesListContainerFiles | GET | Lists container files. |
List ContainersListContainers | GET | Lists containers. |
List items that belong to a ChatKit thread.ListThreadItemsMethod | GET | List items that belong to a ChatKit thread. |
List organization API keysadmin_api_keys_list | GET | Retrieve a paginated list of organization admin API keys. |
Retrieve a ChatKit thread by its identifier.GetThreadMethod | GET | Retrieve a ChatKit thread by its identifier. |
Retrieve a single organization API keyadmin_api_keys_get | GET | Get details for a specific organization API key by its ID. |
Retrieve ContainerRetrieveContainer | GET | Retrieves a container. |
Retrieve Container FileRetrieveContainerFile | GET | Retrieves a container file. |
Retrieve Container File ContentRetrieveContainerFileContent | GET | Retrieves a container file content. |
Returns input token counts of the request.
Returns an object with `object` set to `response.input_tokens` and an `inputGetinputtokencounts | POST | Returns input token counts of the request. |
Returns input token counts of the request.
Returns an object with `object` set to `response.input_tokens` and an `inputbeta_Getinputtokencounts | POST | Returns input token counts of the request. |
Project group role assignments4
Assigns a project role to a group within a project.assign_project_group_role | POST | Assigns a project role to a group within a project. |
Lists the project roles assigned to a group within a project.list_project_group_role_assignments | GET | Lists the project roles assigned to a group within a project. |
Retrieves a project role assigned to a group.retrieve_project_group_role | GET | Retrieves a project role assigned to a group. |
Unassigns a project role from a group within a project.unassign_project_group_role | DELETE | Unassigns a project role from a group within a project. |
Project groups4
Grants a group access to a project.add_project_group | POST | Grants a group access to a project. |
Lists the groups that have access to a project.list_project_groups | GET | Lists the groups that have access to a project. |
Retrieves a project's group.retrieve_project_group | GET | Retrieves a project's group. |
Revokes a group's access to a project.remove_project_group | DELETE | Revokes a group's access to a project. |
Project user role assignments4
Assigns a project role to a user within a project.assign_project_user_role | POST | Assigns a project role to a user within a project. |
Lists the project roles assigned to a user within a project.list_project_user_role_assignments | GET | Lists the project roles assigned to a user within a project. |
Retrieves a project role assigned to a user.retrieve_project_user_role | GET | Retrieves a project role assigned to a user. |
Unassigns a project role from a user within a project.unassign_project_user_role | DELETE | Unassigns a project role from a user within a project. |
Projects23
Adds a user to the project. Users must already be members of the organization to be added to a project.create_project_user | POST | Adds a user to the project. |
Archives a project in the organization. Archived projects cannot be used or updated.archive_project | POST | Archives a project in the organization. |
Create a new project in the organization. Projects can be created and archived, but cannot be deleted.create_project | POST | Create a new project in the organization. |
Creates a new service account in the project. By default, this also returns an unredacted API key for the service accouncreate_project_service_account | POST | Creates a new service account in the project. |
Deletes a service account from the project.
Returns confirmation of service account deletion, or an error if the projecdelete_project_service_account | DELETE | Deletes a service account from the project. |
Deletes a user from the project.
Returns confirmation of project user deletion, or an error if the project is
archived delete_project_user | DELETE | Deletes a user from the project. |
Deletes an API key from the project.
Returns confirmation of the key deletion, or an error if the key belonged to
a serdelete_project_api_key | DELETE | Deletes an API key from the project. |
Deletes model permissions for a project.delete_project_model_permissions | DELETE | Deletes model permissions for a project. |
Modifies a project in the organization.modify_project | POST | Modifies a project in the organization. |
Modifies a user's role in the project.modify_project_user | POST | Modifies a user's role in the project. |
Retrieves a project.retrieve_project | GET | Retrieves a project. |
Retrieves a service account in the project.retrieve_project_service_account | GET | Retrieves a service account in the project. |
Retrieves a user in the project.retrieve_project_user | GET | Retrieves a user in the project. |
Retrieves an API key in the project.retrieve_project_api_key | GET | Retrieves an API key in the project. |
Returns a list of API keys in the project.list_project_api_keys | GET | Returns a list of API keys in the project. |
Returns a list of projects.list_projects | GET | Returns a list of projects. |
Returns a list of service accounts in the project.list_project_service_accounts | GET | Returns a list of service accounts in the project. |
Returns a list of users in the project.list_project_users | GET | Returns a list of users in the project. |
Returns model permissions for a project.retrieve_project_model_permissions | GET | Returns model permissions for a project. |
Returns the rate limits per model for a project.list_project_rate_limits | GET | Returns the rate limits per model for a project. |
Updates a project rate limit.update_project_rate_limits | POST | Updates a project rate limit. |
Updates a service account in the project.update_project_service_account | POST | Updates a service account in the project. |
Updates model permissions for a project.update_project_model_permissions | POST | Updates model permissions for a project. |
Realtime10
Accept an incoming SIP call and configure the realtime session that will
handle it.accept_realtime_call | POST | Accept an incoming SIP call and configure the realtime session that will handle it. |
Create a new Realtime API call over WebRTC and receive the SDP answer needed
to complete the peer connection.create_realtime_call | POST | Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection. |
Create a new Realtime API call over WebRTC and receive the SDP answer needed
to complete the peer connection.create_realtime_call__sdp | POST | Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection. |
Create a Realtime client secret with an associated session configuration.
Client secrets are short-lived tokens that cacreate_realtime_client_secret | POST | Create a Realtime client secret with an associated session configuration. |
Create a Realtime translation client secret with an associated translation session configuration.
Client secrets are shcreate_realtime_translation_client_secret | POST | Create a Realtime translation client secret with an associated translation session configuration. |
Create an ephemeral API token for use in client-side applications with the
Realtime API specifically for realtime transccreate_realtime_transcription_session | POST | Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. |
Create an ephemeral API token for use in client-side applications with the
Realtime API. Can be configured with the samecreate_realtime_session | POST | Create an ephemeral API token for use in client-side applications with the Realtime API. |
Decline an incoming SIP call by returning a SIP status code to the caller.reject_realtime_call | POST | Decline an incoming SIP call by returning a SIP status code to the caller. |
End an active Realtime API call, whether it was initiated over SIP or
WebRTC.hangup_realtime_call | POST | End an active Realtime API call, whether it was initiated over SIP or WebRTC. |
Transfer an active SIP call to a new destination using the SIP REFER verb.refer_realtime_call | POST | Transfer an active SIP call to a new destination using the SIP REFER verb. |
Responses12
Cancels a model response with the given ID. Only responses created with
the `background` parameter set to `true` can be beta_cancelResponse | POST | Cancels a model response with the given ID. |
Cancels a model response with the given ID. Only responses created with
the `background` parameter set to `true` can be cancelResponse | POST | Cancels a model response with the given ID. |
Creates a model response. Provide [text](/docs/guides/text) or
[image](/docs/guides/images) inputs to generate [text](/dbeta_createResponse | POST | Creates a model response. |
Creates a model response. Provide [text](/docs/guides/text) or
[image](/docs/guides/images) inputs to generate [text](/dcreateResponse | POST | Creates a model response. |
Creates a model response. Provide [text](/docs/guides/text) or
[image](/docs/guides/images) inputs to generate [text](/d (exact SSE bytes)beta_createResponseStream | POST | Creates a model response. |
Creates a model response. Provide [text](/docs/guides/text) or
[image](/docs/guides/images) inputs to generate [text](/d (exact SSE bytes)createResponseStream | POST | Creates a model response. |
Deletes a model response with the given ID.
beta_deleteResponse | DELETE | Deletes a model response with the given ID. |
Deletes a model response with the given ID.
deleteResponse | DELETE | Deletes a model response with the given ID. |
Retrieves a model response with the given ID.
beta_getResponse | GET | Retrieves a model response with the given ID. |
Retrieves a model response with the given ID.
getResponse | GET | Retrieves a model response with the given ID. |
Returns a list of input items for a given response.beta_listInputItems | GET | Returns a list of input items for a given response. |
Returns a list of input items for a given response.listInputItems | GET | Returns a list of input items for a given response. |
Roles10
Creates a custom role for a project.create_project_role | POST | Creates a custom role for a project. |
Creates a custom role for the organization.create_role | POST | Creates a custom role for the organization. |
Deletes a custom role from a project.delete_project_role | DELETE | Deletes a custom role from a project. |
Deletes a custom role from the organization.delete_role | DELETE | Deletes a custom role from the organization. |
Lists the roles configured for a project.list_project_roles | GET | Lists the roles configured for a project. |
Lists the roles configured for the organization.list_roles | GET | Lists the roles configured for the organization. |
Retrieves a project role.retrieve_project_role | GET | Retrieves a project role. |
Retrieves an organization role.retrieve_role | GET | Retrieves an organization role. |
Updates an existing organization role.update_role | POST | Updates an existing organization role. |
Updates an existing project role.update_project_role | POST | Updates an existing project role. |
Skills13
Create a new immutable skill version.CreateSkillVersion | POST | Create a new immutable skill version. |
Create a new immutable skill version.CreateSkillVersion__json | POST | Create a new immutable skill version. |
Create a new skill.CreateSkill | POST | Create a new skill. |
Create a new skill.CreateSkill__json | POST | Create a new skill. |
Delete a skill by its ID.DeleteSkill | DELETE | Delete a skill by its ID. |
Delete a skill version.DeleteSkillVersion | DELETE | Delete a skill version. |
Download a skill version zip bundle.GetSkillVersionContent | GET | Download a skill version zip bundle. |
Download a skill zip bundle by its ID.GetSkillContent | GET | Download a skill zip bundle by its ID. |
Get a skill by its ID.GetSkill | GET | Get a skill by its ID. |
Get a specific skill version.GetSkillVersion | GET | Get a specific skill version. |
List all skills for the current project.ListSkills | GET | List all skills for the current project. |
List skill versions for a skill.ListSkillVersions | GET | List skill versions for a skill. |
Update the default version pointer for a skill.UpdateSkillDefaultVersion | POST | Update the default version pointer for a skill. |
Spend alerts10
Creates a project spend alert.create_project_spend_alert | POST | Creates a project spend alert. |
Creates an organization spend alert.create_organization_spend_alert | POST | Creates an organization spend alert. |
Deletes a project spend alert.delete_project_spend_alert | DELETE | Deletes a project spend alert. |
Deletes an organization spend alert.delete_organization_spend_alert | DELETE | Deletes an organization spend alert. |
Lists organization spend alerts.list_organization_spend_alerts | GET | Lists organization spend alerts. |
Lists project spend alerts.list_project_spend_alerts | GET | Lists project spend alerts. |
Retrieves a project spend alert.retrieve_project_spend_alert | GET | Retrieves a project spend alert. |
Retrieves an organization spend alert.retrieve_organization_spend_alert | GET | Retrieves an organization spend alert. |
Updates a project spend alert.update_project_spend_alert | POST | Updates a project spend alert. |
Updates an organization spend alert.update_organization_spend_alert | POST | Updates an organization spend alert. |
Uploads4
Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A PartaddUploadPart | POST | Adds a Part to an Upload object. |
Cancels the Upload. No Parts may be added after an Upload is cancelled.
Returns the Upload object with status `cancellecancelUpload | POST | Cancels the Upload. |
Completes the [Upload](/docs/api-reference/uploads/object).
Within the returned Upload object, there is a nested [FilecompleteUpload | POST | Completes the Upload. |
Creates an intermediate [Upload](/docs/api-reference/uploads/object) object
that you can add [Parts](/docs/api-referencecreateUpload | POST | Creates an intermediate Upload object that you can add Parts to. |
Usage11
Get audio speeches usage details for the organization.usage_audio_speeches | GET | Get audio speeches usage details for the organization. |
Get audio transcriptions usage details for the organization.usage_audio_transcriptions | GET | Get audio transcriptions usage details for the organization. |
Get code interpreter sessions usage details for the organization.usage_code_interpreter_sessions | GET | Get code interpreter sessions usage details for the organization. |
Get completions usage details for the organization.usage_completions | GET | Get completions usage details for the organization. |
Get costs details for the organization.usage_costs | GET | Get costs details for the organization. |
Get embeddings usage details for the organization.usage_embeddings | GET | Get embeddings usage details for the organization. |
Get file search calls usage details for the organization.usage_file_search_calls | GET | Get file search calls usage details for the organization. |
Get images usage details for the organization.usage_images | GET | Get images usage details for the organization. |
Get moderations usage details for the organization.usage_moderations | GET | Get moderations usage details for the organization. |
Get vector stores usage details for the organization.usage_vector_stores | GET | Get vector stores usage details for the organization. |
Get web search calls usage details for the organization.usage_web_search_calls | GET | Get web search calls usage details for the organization. |
User organization role assignments4
Assigns an organization role to a user within the organization.assign_user_role | POST | Assigns an organization role to a user within the organization. |
Lists the organization roles assigned to a user within the organization.list_user_role_assignments | GET | Lists the organization roles assigned to a user within the organization. |
Retrieves an organization role assigned to a user.retrieve_user_role | GET | Retrieves an organization role assigned to a user. |
Unassigns an organization role from a user within the organization.unassign_user_role | DELETE | Unassigns an organization role from a user within the organization. |
Users4
Deletes a user from the organization.delete_user | DELETE | Deletes a user from the organization. |
Lists all of the users in the organization.list_users | GET | Lists all of the users in the organization. |
Modifies a user's role in the organization.modify_user | POST | Modifies a user's role in the organization. |
Retrieves a user by their identifier.retrieve_user | GET | Retrieves a user by their identifier. |
Vector stores16
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.cancelVectorStoreFileBatch | POST | Cancel a vector store file batch. |
Create a vector store file batch.createVectorStoreFileBatch | POST | The maximum number of files in a single batch request is 2000. |
Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vectcreateVectorStoreFile | POST | This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with /vector stores/{vector store id}/file batches. |
Create a vector store.createVectorStore | POST | Create a vector store. |
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To deleteVectorStoreFile | DELETE | Delete a vector store file. |
Delete a vector store.deleteVectorStore | DELETE | Delete a vector store. |
Modifies a vector store.modifyVectorStore | POST | Modifies a vector store. |
Retrieve the parsed contents of a vector store file.retrieveVectorStoreFileContent | GET | Retrieve the parsed contents of a vector store file. |
Retrieves a vector store file batch.getVectorStoreFileBatch | GET | Retrieves a vector store file batch. |
Retrieves a vector store file.getVectorStoreFile | GET | Retrieves a vector store file. |
Retrieves a vector store.getVectorStore | GET | Retrieves a vector store. |
Returns a list of vector store files in a batch.listFilesInVectorStoreBatch | GET | Returns a list of vector store files in a batch. |
Returns a list of vector store files.listVectorStoreFiles | GET | Returns a list of vector store files. |
Returns a list of vector stores.listVectorStores | GET | Returns a list of vector stores. |
Search a vector store for relevant chunks based on a query and file attributes filter.searchVectorStore | POST | Search a vector store for relevant chunks based on a query and file attributes filter. |
Update attributes on a vector store file.updateVectorStoreFileAttributes | POST | Update attributes on a vector store file. |
Videos14
Create a character from an uploaded video.CreateVideoCharacter | POST | Create a character from an uploaded video. |
Create a new video generation job by editing a source video or existing generated video.CreateVideoEdit | POST | Create a new video generation job by editing a source video or existing generated video. |
Create a new video generation job by editing a source video or existing generated video.CreateVideoEdit__json | POST | Create a new video generation job by editing a source video or existing generated video. |
Create a new video generation job from a prompt and optional reference assets.createVideo | POST | Create a new video generation job from a prompt and optional reference assets. |
Create a new video generation job from a prompt and optional reference assets.createVideo__json | POST | Create a new video generation job from a prompt and optional reference assets. |
Create a remix of a completed video using a refreshed prompt.CreateVideoRemix | POST | Create a remix of a completed video using a refreshed prompt. |
Create a remix of a completed video using a refreshed prompt.CreateVideoRemix__json | POST | Create a remix of a completed video using a refreshed prompt. |
Create an extension of a completed video.CreateVideoExtend | POST | Create an extension of a completed video. |
Create an extension of a completed video.CreateVideoExtend__json | POST | Create an extension of a completed video. |
Download the generated video bytes or a derived preview asset.
Streams the rendered video content for the specified vidRetrieveVideoContent | GET | Download the generated video bytes or a derived preview asset. |
Fetch a character.GetVideoCharacter | GET | Fetch a character. |
Fetch the latest metadata for a generated video.GetVideo | GET | Fetch the latest metadata for a generated video. |
List recently generated videos for the current project.ListVideos | GET | List recently generated videos for the current project. |
Permanently delete a completed or failed video and its stored assets.DeleteVideo | DELETE | Permanently delete a completed or failed video and its stored assets. |