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

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for OpenAI and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
API keyRequiredSecretOpenAI API key. Organization administration operations require a key with the corresponding admin permissions.

Use it in a flow

  1. Open a flow, open the node library and search for OpenAI.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. 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`.cancelRunPOSTCancels a run that is in progress.
Create a message.createMessagePOSTCreate a message.
Create a run.createRunPOSTCreate a run.
Create a thread and run it in one request.createThreadAndRunPOSTCreate a thread and run it in one request.
Create a thread.createThreadPOSTCreate a thread.
Create an assistant with a model and instructions.createAssistantPOSTCreate an assistant with a model and instructions.
Delete a thread.deleteThreadDELETEDelete a thread.
Delete an assistant.deleteAssistantDELETEDelete an assistant.
Deletes a message.deleteMessageDELETEDeletes a message.
Modifies a message.modifyMessagePOSTModifies a message.
Modifies a run.modifyRunPOSTModifies a run.
Modifies a thread.modifyThreadPOSTModifies a thread.
Modifies an assistant.modifyAssistantPOSTModifies an assistant.
Retrieve a message.getMessageGETRetrieve a message.
Retrieves a run step.getRunStepGETRetrieves a run step.
Retrieves a run.getRunGETRetrieves a run.
Retrieves a thread.getThreadGETRetrieves a thread.
Retrieves an assistant.getAssistantGETRetrieves an assistant.
Returns a list of assistants.listAssistantsGETReturns a list of assistants.
Returns a list of messages for a given thread.listMessagesGETReturns a list of messages for a given thread.
Returns a list of run steps belonging to a run.listRunStepsGETReturns a list of run steps belonging to a run.
Returns a list of runs belonging to a thread.listRunsGETReturns a list of runs belonging to a thread.
When a run has the `status: "requires_action"` and `required_actionsubmitToolOuputsToRunPOSTWhen 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.createVoicePOSTCreate a custom voice you can use for audio output (for example, in Text-to-Speech and the Realtime API).
Deletes a voice consent recording.deleteVoiceConsentDELETEDelete 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. createSpeechPOSTGenerates 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)createSpeechStreamPOSTGenerates audio from the input text.
Retrieves a voice consent recording.getVoiceConsentGETRetrieve consent recording metadata used for creating custom voices.
Returns a list of voice consent recordings.listVoiceConsentsGETList 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`createTranscriptionPOSTTranscribes 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)createTranscriptionStreamPOSTTranscribes audio into the input language.
Translates audio into English.createTranslationPOSTTranslates audio into English.
Updates a voice consent recording (metadata only).updateVoiceConsentPOSTUpdate consent recording metadata used for creating custom voices.
Upload a voice consent recording.createVoiceConsentPOSTUpload a consent recording that authorizes creation of a custom voice.
Audit Logs1
List user actions and configuration changes within this organization.list_audit_logsGETList 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 `cancellcancelBatchPOSTCancels an in-progress batch.
Creates and executes a batch from an uploaded file of requestscreateBatchPOSTCreates and executes a batch from an uploaded file of requests
List your organization's batches.listBatchesGETList your organization's batches.
Retrieves a batch.retrieveBatchGETRetrieves a batch.
Certificates10
Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at activateOrganizationCertificatesPOSTActivate certificates at the organization level.
Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a timactivateProjectCertificatesPOSTActivate certificates at the project level.
Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificatesdeactivateOrganizationCertificatesPOSTDeactivate certificates at the organization level.
Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at adeactivateProjectCertificatesPOSTDeactivate certificates at the project level.
Delete a certificate from the organization. The certificate must be inactive for the organization and all projects. deleteCertificateDELETEDelete 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 actgetCertificateGETGet a certificate that has been uploaded to the organization.
List certificates for this project.listProjectCertificatesGETList certificates for this project.
List uploaded certificates for this organization.listOrganizationCertificatesGETList uploaded certificates for this organization.
Modify a certificate. Note that only the name can be modified. modifyCertificatePOSTModify a certificate.
Upload a certificate to the organization. This does **not** automatically activate the certificate. Organizations can uuploadCertificatePOSTUpload a certificate to the organization.
Chat7
**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses) to take advantage of the latecreateChatCompletionPOSTStarting a new project?
**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses) to take advantage of the late (exact SSE bytes)createChatCompletionStreamPOSTStarting a new project?
Delete a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` cdeleteChatCompletionDELETEDelete a stored chat completion.
Get a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` willgetChatCompletionGETGet a stored chat completion.
Get the messages in a stored chat completion. Only Chat Completions that have been created with the `store` parameter segetChatCompletionMessagesGETGet 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 listChatCompletionsGETList stored Chat Completions.
Modify a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` cupdateChatCompletionPOSTModify a stored chat completion.
Completions1
Creates a completion for the provided prompt and parameters. Returns a completion object, or a sequence of completion ocreateCompletionPOSTCreates a completion for the provided prompt and parameters.
Conversations8
Create a conversation.createConversationPOSTCreate a conversation.
Create items in a conversation with the given ID.createConversationItemsPOSTCreate items in a conversation with the given ID.
Delete a conversation. Items in the conversation will not be deleted.deleteConversationDELETEDelete a conversation.
Delete an item from a conversation with the given IDs.deleteConversationItemDELETEDelete an item from a conversation with the given IDs.
Get a conversationgetConversationGETGet a conversation
Get a single item from a conversation with the given IDs.getConversationItemGETGet a single item from a conversation with the given IDs.
List all items for a conversation with the given ID.listConversationItemsGETList all items for a conversation with the given ID.
Update a conversationupdateConversationPOSTUpdate a conversation
Data retention4
Retrieves organization data retention controls.retrieve_organization_data_retentionGETRetrieves organization data retention controls.
Retrieves project data retention controls.retrieve_project_data_retentionGETRetrieves project data retention controls.
Updates organization data retention controls.update_organization_data_retentionPOSTUpdates organization data retention controls.
Updates project data retention controls.update_project_data_retentionPOSTUpdates project data retention controls.
Embeddings1
Creates an embedding vector representing the input text.createEmbeddingPOSTCreates an embedding vector representing the input text.
Evals12
Cancel an ongoing evaluation run. cancelEvalRunPOSTCancel 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 createEvalPOSTCreate the structure of an evaluation that can be used to test a model's performance.
Delete an eval run. deleteEvalRunDELETEDelete an eval run.
Delete an evaluation. deleteEvalDELETEDelete an evaluation.
Get a list of output items for an evaluation run. getEvalRunOutputItemsGETGet a list of output items for an evaluation run.
Get a list of runs for an evaluation. getEvalRunsGETGet a list of runs for an evaluation.
Get an evaluation by ID. getEvalGETGet an evaluation by ID.
Get an evaluation run by ID. getEvalRunGETGet an evaluation run by ID.
Get an evaluation run output item by ID. getEvalRunOutputItemGETGet an evaluation run output item by ID.
Kicks off a new run for a given evaluation, specifying the data source…createEvalRunPOSTKicks 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. listEvalsGETList evaluations for a project.
Update certain properties of an evaluation. updateEvalPOSTUpdate certain properties of an evaluation.
Files5
Delete a file and remove it from all vector stores.deleteFileDELETEDelete a file and remove it from all vector stores.
Returns a list of files.listFilesGETReturns a list of files.
Returns a response containing the contents of the specified file.downloadFileGETReturns a response containing the contents of the specified file.
Returns information about a specific file.retrieveFileGETReturns 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 storcreateFilePOSTUpload 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 shacreateFineTuningCheckpointPermissionPOSTNOTE: 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 dedeleteFineTuningCheckpointPermissionDELETENOTE: 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 vilistFineTuningCheckpointPermissionsGETNOTE: 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 detacreateFineTuningJobPOSTCreates 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) retrieveFineTuningJobGETGet info about a fine-tuning job.
Get status updates for a fine-tuning job. listFineTuningEventsGETGet status updates for a fine-tuning job.
Immediately cancel a fine-tune job. cancelFineTuningJobPOSTImmediately cancel a fine-tune job.
List checkpoints for a fine-tuning job. listFineTuningJobCheckpointsGETList checkpoints for a fine-tuning job.
List your organization's fine-tuning jobs listPaginatedFineTuningJobsGETList your organization's fine-tuning jobs
Pause a fine-tune job. pauseFineTuningJobPOSTPause a fine-tune job.
Resume a fine-tune job. resumeFineTuningJobPOSTResume a fine-tune job.
Run a grader. runGraderPOSTRun a grader.
Validate a grader. validateGraderPOSTValidate a grader.
Group organization role assignments4
Assigns an organization role to a group within the organization.assign_group_rolePOSTAssigns an organization role to a group within the organization.
Lists the organization roles assigned to a group within the organization.list_group_role_assignmentsGETLists the organization roles assigned to a group within the organization.
Retrieves an organization role assigned to a group.retrieve_group_roleGETRetrieves an organization role assigned to a group.
Unassigns an organization role from a group within the organization.unassign_group_roleDELETEUnassigns an organization role from a group within the organization.
Group users4
Adds a user to a group.add_group_userPOSTAdds a user to a group.
Lists the users assigned to a group.list_group_usersGETLists the users assigned to a group.
Removes a user from a group.remove_group_userDELETERemoves a user from a group.
Retrieves a user in a group.retrieve_group_userGETRetrieves a user in a group.
Groups5
Creates a new group in the organization.create_groupPOSTCreates a new group in the organization.
Deletes a group from the organization.delete_groupDELETEDeletes a group from the organization.
Lists all groups in the organization.list_groupsGETLists all groups in the organization.
Retrieves a group.retrieve_groupGETRetrieves a group.
Updates a group's information.update_groupPOSTUpdates a group's information.
Hosted tools2
Returns hosted tool permissions for a project.retrieve_project_hosted_tool_permissionsGETReturns hosted tool permissions for a project.
Updates hosted tool permissions for a project.update_project_hosted_tool_permissionsPOSTUpdates hosted tool permissions for a project.
Images7
Creates a variation of a given image. This endpoint only supports `dall-e-2`.createImageVariationPOSTCreates 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 modelcreateImageEditPOSTYou 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__multipartPOSTYou 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)createImageEditStreamPOSTYou 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__multipartStreamPOSTYou 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). createImagePOSTCreates an image given a prompt.
Creates an image given a prompt. [Learn more](/docs/guides/images). (exact SSE bytes)createImageStreamPOSTCreates 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 inviteUserPOSTCreate an invite for a user to the organization.
Delete an invite. If the invite has already been accepted, it cannot be deleted.delete_inviteDELETEDelete an invite.
Retrieves an invite.retrieve_inviteGETRetrieves an invite.
Returns a list of invites in the organization.list_invitesGETReturns 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.deleteModelDELETEDelete a fine-tuned model.
Lists the currently available models, and provides basic information about each one such as the owner and availability.listModelsGETLists 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.retrieveModelGETRetrieves 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/moderacreateModerationPOSTClassifies 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 iCancelChatSessionMethodPOSTCancel 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](/apCreatecontentprovenancecheckPOSTCheck 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 iCompactconversationPOSTCompact a conversation.
Compact a conversation. Returns a compacted response object. Learn when and how to compact long-running conversations ibeta_CompactconversationPOSTCompact a conversation.
Create a ChatKit session.CreateChatSessionMethodPOSTCreate 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 CreateContainerFilePOSTCreates 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__multipartPOSTCreates a container file.
Create an organization admin API keyadmin_api_keys_createPOSTCreate a new admin-level API key for the organization.
Create ContainerCreateContainerPOSTCreates a container.
Create or replace a project's hard spend limit.UpdateprojectspendlimitPOSTCreate or replace a project's hard spend limit.
Create or replace the organization's hard spend limit.UpdateorganizationspendlimitPOSTCreate or replace the organization's hard spend limit.
Creates an API key for a service account in the project.CreateanAPIkeyforaserviceaccountPOSTCreates an API key for a service account in the project.
Delete a ChatKit thread along with its items and stored attachments.DeleteThreadMethodDELETEDelete a ChatKit thread along with its items and stored attachments.
Delete a project's hard spend limit.DeleteprojectspendlimitDELETEDelete a project's hard spend limit.
Delete an organization admin API keyadmin_api_keys_deleteDELETEDelete the specified admin API key.
Delete ContainerDeleteContainerDELETEDelete a container.
Delete Container FileDeleteContainerFileDELETEDelete a container file.
Delete the organization's hard spend limit.DeleteorganizationspendlimitDELETEDelete the organization's hard spend limit.
Get a project's hard spend limit.GetprojectspendlimitGETGet a project's hard spend limit.
Get the organization's hard spend limit.GetorganizationspendlimitGETGet the organization's hard spend limit.
List ChatKit threads with optional pagination and user filters.ListThreadsMethodGETList ChatKit threads with optional pagination and user filters.
List Container filesListContainerFilesGETLists container files.
List ContainersListContainersGETLists containers.
List items that belong to a ChatKit thread.ListThreadItemsMethodGETList items that belong to a ChatKit thread.
List organization API keysadmin_api_keys_listGETRetrieve a paginated list of organization admin API keys.
Retrieve a ChatKit thread by its identifier.GetThreadMethodGETRetrieve a ChatKit thread by its identifier.
Retrieve a single organization API keyadmin_api_keys_getGETGet details for a specific organization API key by its ID.
Retrieve ContainerRetrieveContainerGETRetrieves a container.
Retrieve Container FileRetrieveContainerFileGETRetrieves a container file.
Retrieve Container File ContentRetrieveContainerFileContentGETRetrieves a container file content.
Returns input token counts of the request. Returns an object with `object` set to `response.input_tokens` and an `inputGetinputtokencountsPOSTReturns 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_GetinputtokencountsPOSTReturns input token counts of the request.
Project group role assignments4
Assigns a project role to a group within a project.assign_project_group_rolePOSTAssigns a project role to a group within a project.
Lists the project roles assigned to a group within a project.list_project_group_role_assignmentsGETLists the project roles assigned to a group within a project.
Retrieves a project role assigned to a group.retrieve_project_group_roleGETRetrieves a project role assigned to a group.
Unassigns a project role from a group within a project.unassign_project_group_roleDELETEUnassigns a project role from a group within a project.
Project groups4
Grants a group access to a project.add_project_groupPOSTGrants a group access to a project.
Lists the groups that have access to a project.list_project_groupsGETLists the groups that have access to a project.
Retrieves a project's group.retrieve_project_groupGETRetrieves a project's group.
Revokes a group's access to a project.remove_project_groupDELETERevokes a group's access to a project.
Project user role assignments4
Assigns a project role to a user within a project.assign_project_user_rolePOSTAssigns a project role to a user within a project.
Lists the project roles assigned to a user within a project.list_project_user_role_assignmentsGETLists the project roles assigned to a user within a project.
Retrieves a project role assigned to a user.retrieve_project_user_roleGETRetrieves a project role assigned to a user.
Unassigns a project role from a user within a project.unassign_project_user_roleDELETEUnassigns 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_userPOSTAdds a user to the project.
Archives a project in the organization. Archived projects cannot be used or updated.archive_projectPOSTArchives a project in the organization.
Create a new project in the organization. Projects can be created and archived, but cannot be deleted.create_projectPOSTCreate 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_accountPOSTCreates 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_accountDELETEDeletes 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_userDELETEDeletes 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_keyDELETEDeletes an API key from the project.
Deletes model permissions for a project.delete_project_model_permissionsDELETEDeletes model permissions for a project.
Modifies a project in the organization.modify_projectPOSTModifies a project in the organization.
Modifies a user's role in the project.modify_project_userPOSTModifies a user's role in the project.
Retrieves a project.retrieve_projectGETRetrieves a project.
Retrieves a service account in the project.retrieve_project_service_accountGETRetrieves a service account in the project.
Retrieves a user in the project.retrieve_project_userGETRetrieves a user in the project.
Retrieves an API key in the project.retrieve_project_api_keyGETRetrieves an API key in the project.
Returns a list of API keys in the project.list_project_api_keysGETReturns a list of API keys in the project.
Returns a list of projects.list_projectsGETReturns a list of projects.
Returns a list of service accounts in the project.list_project_service_accountsGETReturns a list of service accounts in the project.
Returns a list of users in the project.list_project_usersGETReturns a list of users in the project.
Returns model permissions for a project.retrieve_project_model_permissionsGETReturns model permissions for a project.
Returns the rate limits per model for a project.list_project_rate_limitsGETReturns the rate limits per model for a project.
Updates a project rate limit.update_project_rate_limitsPOSTUpdates a project rate limit.
Updates a service account in the project.update_project_service_accountPOSTUpdates a service account in the project.
Updates model permissions for a project.update_project_model_permissionsPOSTUpdates model permissions for a project.
Realtime10
Accept an incoming SIP call and configure the realtime session that will handle it.accept_realtime_callPOSTAccept 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_callPOSTCreate 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__sdpPOSTCreate 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_secretPOSTCreate 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_secretPOSTCreate 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_sessionPOSTCreate 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_sessionPOSTCreate 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_callPOSTDecline 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_callPOSTEnd 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_callPOSTTransfer 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_cancelResponsePOSTCancels 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 cancelResponsePOSTCancels 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_createResponsePOSTCreates a model response.
Creates a model response. Provide [text](/docs/guides/text) or [image](/docs/guides/images) inputs to generate [text](/dcreateResponsePOSTCreates 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_createResponseStreamPOSTCreates 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)createResponseStreamPOSTCreates a model response.
Deletes a model response with the given ID. beta_deleteResponseDELETEDeletes a model response with the given ID.
Deletes a model response with the given ID. deleteResponseDELETEDeletes a model response with the given ID.
Retrieves a model response with the given ID. beta_getResponseGETRetrieves a model response with the given ID.
Retrieves a model response with the given ID. getResponseGETRetrieves a model response with the given ID.
Returns a list of input items for a given response.beta_listInputItemsGETReturns a list of input items for a given response.
Returns a list of input items for a given response.listInputItemsGETReturns a list of input items for a given response.
Roles10
Creates a custom role for a project.create_project_rolePOSTCreates a custom role for a project.
Creates a custom role for the organization.create_rolePOSTCreates a custom role for the organization.
Deletes a custom role from a project.delete_project_roleDELETEDeletes a custom role from a project.
Deletes a custom role from the organization.delete_roleDELETEDeletes a custom role from the organization.
Lists the roles configured for a project.list_project_rolesGETLists the roles configured for a project.
Lists the roles configured for the organization.list_rolesGETLists the roles configured for the organization.
Retrieves a project role.retrieve_project_roleGETRetrieves a project role.
Retrieves an organization role.retrieve_roleGETRetrieves an organization role.
Updates an existing organization role.update_rolePOSTUpdates an existing organization role.
Updates an existing project role.update_project_rolePOSTUpdates an existing project role.
Skills13
Create a new immutable skill version.CreateSkillVersionPOSTCreate a new immutable skill version.
Create a new immutable skill version.CreateSkillVersion__jsonPOSTCreate a new immutable skill version.
Create a new skill.CreateSkillPOSTCreate a new skill.
Create a new skill.CreateSkill__jsonPOSTCreate a new skill.
Delete a skill by its ID.DeleteSkillDELETEDelete a skill by its ID.
Delete a skill version.DeleteSkillVersionDELETEDelete a skill version.
Download a skill version zip bundle.GetSkillVersionContentGETDownload a skill version zip bundle.
Download a skill zip bundle by its ID.GetSkillContentGETDownload a skill zip bundle by its ID.
Get a skill by its ID.GetSkillGETGet a skill by its ID.
Get a specific skill version.GetSkillVersionGETGet a specific skill version.
List all skills for the current project.ListSkillsGETList all skills for the current project.
List skill versions for a skill.ListSkillVersionsGETList skill versions for a skill.
Update the default version pointer for a skill.UpdateSkillDefaultVersionPOSTUpdate the default version pointer for a skill.
Spend alerts10
Creates a project spend alert.create_project_spend_alertPOSTCreates a project spend alert.
Creates an organization spend alert.create_organization_spend_alertPOSTCreates an organization spend alert.
Deletes a project spend alert.delete_project_spend_alertDELETEDeletes a project spend alert.
Deletes an organization spend alert.delete_organization_spend_alertDELETEDeletes an organization spend alert.
Lists organization spend alerts.list_organization_spend_alertsGETLists organization spend alerts.
Lists project spend alerts.list_project_spend_alertsGETLists project spend alerts.
Retrieves a project spend alert.retrieve_project_spend_alertGETRetrieves a project spend alert.
Retrieves an organization spend alert.retrieve_organization_spend_alertGETRetrieves an organization spend alert.
Updates a project spend alert.update_project_spend_alertPOSTUpdates a project spend alert.
Updates an organization spend alert.update_organization_spend_alertPOSTUpdates an organization spend alert.
Uploads4
Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A PartaddUploadPartPOSTAdds 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 `cancellecancelUploadPOSTCancels the Upload.
Completes the [Upload](/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [FilecompleteUploadPOSTCompletes the Upload.
Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-referencecreateUploadPOSTCreates an intermediate Upload object that you can add Parts to.
Usage11
Get audio speeches usage details for the organization.usage_audio_speechesGETGet audio speeches usage details for the organization.
Get audio transcriptions usage details for the organization.usage_audio_transcriptionsGETGet audio transcriptions usage details for the organization.
Get code interpreter sessions usage details for the organization.usage_code_interpreter_sessionsGETGet code interpreter sessions usage details for the organization.
Get completions usage details for the organization.usage_completionsGETGet completions usage details for the organization.
Get costs details for the organization.usage_costsGETGet costs details for the organization.
Get embeddings usage details for the organization.usage_embeddingsGETGet embeddings usage details for the organization.
Get file search calls usage details for the organization.usage_file_search_callsGETGet file search calls usage details for the organization.
Get images usage details for the organization.usage_imagesGETGet images usage details for the organization.
Get moderations usage details for the organization.usage_moderationsGETGet moderations usage details for the organization.
Get vector stores usage details for the organization.usage_vector_storesGETGet vector stores usage details for the organization.
Get web search calls usage details for the organization.usage_web_search_callsGETGet web search calls usage details for the organization.
User organization role assignments4
Assigns an organization role to a user within the organization.assign_user_rolePOSTAssigns an organization role to a user within the organization.
Lists the organization roles assigned to a user within the organization.list_user_role_assignmentsGETLists the organization roles assigned to a user within the organization.
Retrieves an organization role assigned to a user.retrieve_user_roleGETRetrieves an organization role assigned to a user.
Unassigns an organization role from a user within the organization.unassign_user_roleDELETEUnassigns an organization role from a user within the organization.
Users4
Deletes a user from the organization.delete_userDELETEDeletes a user from the organization.
Lists all of the users in the organization.list_usersGETLists all of the users in the organization.
Modifies a user's role in the organization.modify_userPOSTModifies a user's role in the organization.
Retrieves a user by their identifier.retrieve_userGETRetrieves 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.cancelVectorStoreFileBatchPOSTCancel a vector store file batch.
Create a vector store file batch.createVectorStoreFileBatchPOSTThe 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/vectcreateVectorStoreFilePOSTThis 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.createVectorStorePOSTCreate 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 deleteVectorStoreFileDELETEDelete a vector store file.
Delete a vector store.deleteVectorStoreDELETEDelete a vector store.
Modifies a vector store.modifyVectorStorePOSTModifies a vector store.
Retrieve the parsed contents of a vector store file.retrieveVectorStoreFileContentGETRetrieve the parsed contents of a vector store file.
Retrieves a vector store file batch.getVectorStoreFileBatchGETRetrieves a vector store file batch.
Retrieves a vector store file.getVectorStoreFileGETRetrieves a vector store file.
Retrieves a vector store.getVectorStoreGETRetrieves a vector store.
Returns a list of vector store files in a batch.listFilesInVectorStoreBatchGETReturns a list of vector store files in a batch.
Returns a list of vector store files.listVectorStoreFilesGETReturns a list of vector store files.
Returns a list of vector stores.listVectorStoresGETReturns a list of vector stores.
Search a vector store for relevant chunks based on a query and file attributes filter.searchVectorStorePOSTSearch a vector store for relevant chunks based on a query and file attributes filter.
Update attributes on a vector store file.updateVectorStoreFileAttributesPOSTUpdate attributes on a vector store file.
Videos14
Create a character from an uploaded video.CreateVideoCharacterPOSTCreate a character from an uploaded video.
Create a new video generation job by editing a source video or existing generated video.CreateVideoEditPOSTCreate 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__jsonPOSTCreate 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.createVideoPOSTCreate 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__jsonPOSTCreate a new video generation job from a prompt and optional reference assets.
Create a remix of a completed video using a refreshed prompt.CreateVideoRemixPOSTCreate a remix of a completed video using a refreshed prompt.
Create a remix of a completed video using a refreshed prompt.CreateVideoRemix__jsonPOSTCreate a remix of a completed video using a refreshed prompt.
Create an extension of a completed video.CreateVideoExtendPOSTCreate an extension of a completed video.
Create an extension of a completed video.CreateVideoExtend__jsonPOSTCreate an extension of a completed video.
Download the generated video bytes or a derived preview asset. Streams the rendered video content for the specified vidRetrieveVideoContentGETDownload the generated video bytes or a derived preview asset.
Fetch a character.GetVideoCharacterGETFetch a character.
Fetch the latest metadata for a generated video.GetVideoGETFetch the latest metadata for a generated video.
List recently generated videos for the current project.ListVideosGETList recently generated videos for the current project.
Permanently delete a completed or failed video and its stored assets.DeleteVideoDELETEPermanently delete a completed or failed video and its stored assets.