> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAI

> How to set up the OpenAI connector, plus the actions and events that are available.

![OpenAI](https://stackone-logos.com/api/openai/filled/svg)

v1.2.4[See changelog](https://docs.stackone.com/connectors/openai/changelog.md)

[121 actions](#actions) · [16 events](#events) · 3 auth methods

AI
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key (Admin + User) · Connector Profile](https://docs.stackone.com/connectors/openai/guides/connector-profile/api-key-admin-user.md)
>
> Combines a standard API key with an admin API key, so both standard and organization management actions are available. N...

> [card] [User API Key · Connector Profile](https://docs.stackone.com/connectors/openai/guides/connector-profile/user-api-key.md)
>
> Uses a standard project or user API key. Organization and project management actions are not available.

> [card] [Admin API Key · Connector Profile](https://docs.stackone.com/connectors/openai/guides/connector-profile/admin-api-key.md)
>
> Uses an admin API key for organization, project and admin actions.

Optionally, configure receiving Events for OpenAI into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/openai/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key (Admin + User) · Link Account](https://docs.stackone.com/connectors/openai/guides/link-account/api-key-admin-user.md)

> [card] [User API Key · Link Account](https://docs.stackone.com/connectors/openai/guides/link-account/user-api-key.md)

> [card] [Admin API Key · Link Account](https://docs.stackone.com/connectors/openai/guides/link-account/admin-api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key (Admin + User)

Admin API Key

User API Key

No auth methods found

121 actions

ActionDescription

Get Unified Credentials`openai_unified_get_me`

Get the current OpenAI connection's unified credentials and identity.

List Unified Groups`openai_unified_list_groups`

List unified groups in OpenAI.

Get Unified Group`openai_unified_get_group`

Get a unified OpenAI group by ID.

List Unified Organizations`openai_unified_list_organizations`

List unified organizations in OpenAI.

Get Unified Organization`openai_unified_get_organization`

Get a unified OpenAI organization by ID.

List Unified Resource Types`openai_unified_list_resource_types`

List unified resource types in OpenAI.

List Unified Resource Users`openai_unified_list_resource_users`

List unified resource users in OpenAI.

List Unified Roles`openai_unified_list_roles`

List unified roles in OpenAI.

Get Unified Role`openai_unified_get_role`

Get a unified OpenAI role by ID.

List Unified Users`openai_unified_list_users`

List unified users in OpenAI.

Get Unified User`openai_unified_get_user`

Get a unified OpenAI user by ID.

List Models`openai_list_models`

List all currently available models with their permissions and metadata.

Retrieve Model`openai_retrieve_model`

Get detailed information about a specific model.

Delete Fine-tuned Model`openai_delete_fine_tuned_model`

Delete a fine-tuned model. You must have the Owner role.

Create Transcription`openai_create_transcription`

Transcribes audio into the input language.

Create Translation`openai_create_translation`

Translates audio into English.

Create Speech`openai_create_speech`

Generates audio from the input text.

Create Response`openai_create_response`

Create a response using the new Responses API (replaces Assistants).

Retrieve Response`openai_retrieve_response`

Retrieve a response by its ID.

Delete Response`openai_delete_response`

Delete a response by its ID.

List Response Input Items`openai_list_response_input_items`

List input items for a specific response.

Count Response Input Tokens`openai_count_response_input_tokens`

Get input token counts for a request.

Cancel Response`openai_cancel_response`

Cancel a model response with the given ID.

Compact Response`openai_compact_response`

Compact a conversation.

Create Client Secret`openai_create_client_secret`

Create a Realtime client secret with session configuration.

Create Conversation`openai_create_conversation`

Create a conversation.

Retrieve Conversation`openai_retrieve_conversation`

Get a conversation.

Update Conversation`openai_update_conversation`

Update a conversation.

Delete Conversation`openai_delete_conversation`

Delete a conversation.

Create Conversation Items`openai_create_conversation_items`

Create items in a conversation.

List Conversation Items`openai_list_conversation_items`

List all items for a conversation.

Retrieve Conversation Item`openai_retrieve_conversation_item`

Get a single item from a conversation.

Delete Conversation Item`openai_delete_conversation_item`

Delete an item from a conversation.

Create Container`openai_create_container`

Create a new container.

Retrieve Container`openai_retrieve_container`

Get a specific container by ID.

Delete Container`openai_delete_container`

Delete a container.

List Containers`openai_list_containers`

List all containers.

List Container Files`openai_list_container_files`

List files in a container.

Create Container File`openai_create_container_file`

Upload a file to a container.

Retrieve Container File`openai_retrieve_container_file`

Get a specific file from a container.

Delete Container File`openai_delete_container_file`

Delete a file from a container.

Retrieve Container File Content`openai_retrieve_container_file_content`

Download the actual content of a file from a container.

List Organization Users`openai_list_organization_users`

Lists all of the users in the organization.

Retrieve Organization User`openai_retrieve_organization_user`

Retrieves a user by their identifier.

Delete Organization User`openai_delete_organization_user`

Deletes a user from the organization.

Modify Organization User`openai_modify_organization_user`

Modifies a user's role in the organization.

Create Organization Invite`openai_create_organization_invite`

Create an invite for a user to the organization.

List Organization Invites`openai_list_organization_invites`

Returns a list of invites in the organization.

Retrieve Organization Invite`openai_retrieve_organization_invite`

Retrieves an invite.

Delete Organization Invite`openai_delete_organization_invite`

Delete an invite. If the invite has already been accepted, it cannot be deleted.

List Organization Groups`openai_list_organization_groups`

Lists all groups in the organization.

Create Organization Group`openai_create_organization_group`

Creates a new group in the organization.

Update Organization Group`openai_update_organization_group`

Updates a group's information.

Delete Organization Group`openai_delete_organization_group`

Deletes a group from the organization.

List Group Users`openai_list_group_users`

Lists the users assigned to a group.

Add Group User`openai_add_group_user`

Adds a user to a group.

Remove Group User`openai_remove_group_user`

Removes a user from a group.

Assign Organization Role To Group`openai_assign_organization_role_to_group`

Assigns an organization role to a group within the organization.

List Group Organization Role Assignments`openai_list_group_organization_role_assignments`

Lists the organization roles assigned to a group within the organization.

Unassign Organization Role From Group`openai_unassign_organization_role_from_group`

Unassigns an organization role from a group within the organization.

List Organization Roles`openai_list_organization_roles`

Lists the roles configured for the organization.

Create Organization Role`openai_create_organization_role`

Creates a custom role for the organization.

Update Organization Role`openai_update_organization_role`

Updates an existing organization role.

Delete Organization Role`openai_delete_organization_role`

Deletes a custom role from the organization.

List Organization Projects`openai_list_organization_projects`

Lists all of the projects in the organization.

Retrieve Organization Project`openai_retrieve_organization_project`

Retrieves a project.

Create Organization Project`openai_create_organization_project`

Create a new project in the organization.

Modify Organization Project`openai_modify_organization_project`

Modifies a project in the organization.

Archive Organization Project`openai_archive_organization_project`

Archives a project in the organization.

Create Project User`openai_create_project_user`

Adds a user to the project.

List Project Users`openai_list_project_users`

Returns a list of users in the project.

Retrieve Project User`openai_retrieve_project_user`

Retrieves a user in the project.

Modify Project User`openai_modify_project_user`

Modifies a user's role in the project.

Delete Project User`openai_delete_project_user`

Deletes a user from the project.

Create Project Service Account`openai_create_project_service_account`

Creates a new service account in the project.

List Project Service Accounts`openai_list_project_service_accounts`

Returns a list of service accounts in the project.

Retrieve Project Service Account`openai_retrieve_project_service_account`

Retrieves a service account in the project.

Delete Project Service Account`openai_delete_project_service_account`

Deletes a service account from the project.

List Project API Keys`openai_list_project_api_keys`

Returns a list of API keys in the project.

Retrieve Project API Key`openai_retrieve_project_api_key`

Retrieves an API key in the project.

Delete Project API Key`openai_delete_project_api_key`

Deletes an API key from the project.

List Project Rate Limits`openai_list_project_rate_limits`

Returns the rate limits per model for a project.

Modify Project Rate Limit`openai_modify_project_rate_limit`

Updates a project rate limit.

List Project Groups`openai_list_project_groups`

Lists the groups that have access to a project.

Add Project Group`openai_add_project_group`

Grants a group access to a project.

Remove Project Group`openai_remove_project_group`

Revokes a group's access to a project.

Get Audio Speeches Usage`openai_get_audio_speeches_usage`

Get usage statistics for audio speech generation.

Get Audio Transcriptions Usage`openai_get_audio_transcriptions_usage`

Get usage statistics for audio transcription.

Get Code Interpreter Sessions Usage`openai_get_code_interpreter_sessions_usage`

Get usage statistics for code interpreter sessions.

Get Completions Usage`openai_get_completions_usage`

Get usage statistics for completions.

Get Embeddings Usage`openai_get_embeddings_usage`

Get usage statistics for embeddings.

Get Images Usage`openai_get_images_usage`

Get usage statistics for image generation.

Get Moderations Usage`openai_get_moderations_usage`

Get usage statistics for content moderation.

Get Vector Stores Usage`openai_get_vector_stores_usage`

Get usage statistics for vector stores.

Create Admin API Key`openai_create_admin_api_key`

Create an admin API key for the organization.

Retrieve Admin API Key`openai_retrieve_admin_api_key`

Retrieve an admin API key by ID.

Delete Admin API Key`openai_delete_admin_api_key`

Delete an admin API key.

List Admin API Keys`openai_list_admin_api_keys`

List all admin API keys for the organization.

Get Costs`openai_get_costs`

Get organization costs for audit logging.

List Audit Logs`openai_list_audit_logs`

List audit log events for the organization.

List Project Roles`openai_list_project_roles`

List all custom roles for a project.

Create Project Role`openai_create_project_role`

Create a custom role for a project.

Update Project Role`openai_update_project_role`

Update a custom role for a project.

Delete Project Role`openai_delete_project_role`

Delete a custom role from a project.

List Project Group Roles`openai_list_project_group_roles`

List all roles assigned to a group in a project.

Assign Role To Project Group`openai_assign_project_group_role`

Assign a role to a group in a project.

Unassign Role From Project Group`openai_unassign_project_group_role`

Remove a role from a group in a project.

List Project User Roles`openai_list_project_user_roles`

List all roles assigned to a user in a project.

Assign Role To Project User`openai_assign_project_user_role`

Assign a role to a user in a project.

Unassign Role From Project User`openai_unassign_project_user_role`

Remove a role from a user in a project.

Create Skill`openai_create_skill`

Create a new skill by uploading a ZIP file.

Get Skill`openai_get_skill`

Get a skill by its ID. Requires Skills API beta access.

List Skills`openai_list_skills`

List all skills for the current project.

Update Skill`openai_update_skill`

Update the default version pointer for a skill.

Delete Skill`openai_delete_skill`

Delete a skill by its ID.

Download Skill Content`openai_download_skill_content`

Download a skill zip bundle by its ID.

Create Skill Version`openai_create_skill_version`

Create a new version of an existing skill.

List Skill Versions`openai_list_skill_versions`

List all versions of a skill.

Get Skill Version`openai_get_skill_version`

Get a specific version of a skill.

Delete Skill Version`openai_delete_skill_version`

Delete a specific version of a skill.

Download Skill Version Content`openai_download_skill_version_content`

Download a specific version of a skill as a ZIP bundle.

## Events

Tags

Select all
|
Clear

Batches

Evals

Live Calls

Realtime Calls

Responses

Videos

Webhooks

No tags found

16 events

EventDescriptionTags

Active Check`openai_active_check`

Responds with 200 OK to any OpenAI webhook delivery that does not match a known event type.

Webhooks

Batch Completed`openai_webhook_batch_completed`

Fired when a Batch API job completes (batch.completed).

BatchesWebhooks

Batch Failed`openai_webhook_batch_failed`

Fired when a Batch API job fails (batch.failed).

BatchesWebhooks

Batch Expired`openai_webhook_batch_expired`

Fired when a Batch API job expires before finishing its 24h completion window (batch.expired).

BatchesWebhooks

Batch Cancelled`openai_webhook_batch_cancelled`

Fired when a Batch API job is cancelled (batch.cancelled).

BatchesWebhooks

Response Completed`openai_webhook_response_completed`

Fired when a background Response (created with `background: true`) finishes successfully (response.completed).

ResponsesWebhooks

Response Failed`openai_webhook_response_failed`

Fired when a background Response fails (response.failed).

ResponsesWebhooks

Response Cancelled`openai_webhook_response_cancelled`

Fired when a background Response is cancelled (response.cancelled).

ResponsesWebhooks

Response Incomplete`openai_webhook_response_incomplete`

Fired when a background Response is interrupted or ends incomplete (response.incomplete).

ResponsesWebhooks

Eval Run Succeeded`openai_webhook_eval_run_succeeded`

Fired when an eval run succeeds (eval.run.succeeded).

EvalsWebhooks

Eval Run Failed`openai_webhook_eval_run_failed`

Fired when an eval run fails (eval.run.failed).

EvalsWebhooks

Eval Run Canceled`openai_webhook_eval_run_canceled`

Fired when an eval run is canceled (note the single-l `canceled` spelling) (eval.run.canceled).

EvalsWebhooks

Realtime Call Incoming`openai_webhook_realtime_call_incoming`

Fired when an inbound SIP call arrives and is awaiting acceptance via the Realtime API (realtime.call.incoming).

Realtime CallsWebhooks

Video Completed`openai_webhook_video_completed`

Fired when a video generation job completes (video.completed).

VideosWebhooks

Video Failed`openai_webhook_video_failed`

Fired when a video generation job fails (video.failed).

VideosWebhooks

Live Call Incoming`openai_webhook_live_call_incoming`

Fired when an inbound SIP call arrives and is awaiting acceptance via the Live API (live.call.incoming).

Live CallsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.