- Category: artificial intelligence
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 128
- Triggers: 0
- Slug:
OPENAI - Version: 20261101_00
- Instant: Supported on the latest version. Support varies by tool.
Tools
Add Upload Part
Add Upload Part
OPENAI_ADD_UPLOAD_PARTTool to add a part (chunk of bytes) to an Upload object. Use when uploading large files in chunks, with each part up to 64 MB.Input Parameters
Output
Cancel batch
Cancel batch
Cancel evaluation run
Cancel evaluation run
Cancel Response
Cancel Response
OPENAI_CANCEL_RESPONSETool to cancel a background model response by its ID. Use when you need to stop a response that was created with the ‘background’ parameter set to true. Only background responses can be cancelled; attempting to cancel a non-background response will fail.Input Parameters
Output
Cancel Run
Cancel Run
Cancel upload
Cancel upload
Compact Response
Compact Response
OPENAI_COMPACT_RESPONSETool to compact a conversation or response to reduce token usage. Use when you need to reduce the size of long conversations while preserving important context. Either provide an array of input messages or reference a previous response ID to compact.Input Parameters
Output
Complete Upload
Complete Upload
Create Audio Transcription
Create Audio Transcription
OPENAI_CREATE_AUDIO_TRANSCRIPTIONTranscribes audio files to text via the OpenAI Audio Transcriptions API, optionally returning timestamps.Input Parameters
Output
Create Audio Translation
Create Audio Translation
OPENAI_CREATE_AUDIO_TRANSLATIONTool to translate audio files to English text via OpenAI Audio Translations API. Use when you need to convert speech in audio files (any language) to English text.Input Parameters
Output
Create Batch
Create Batch
OPENAI_CREATE_BATCHTool to create and execute a batch from an uploaded file of requests. Use after uploading a JSONL file with purpose ‘batch’ to process multiple API requests in a single batch operation.Input Parameters
Output
Create Chat Completion
Create Chat Completion
OPENAI_CREATE_CHAT_COMPLETIONCreates a chat completion from OpenAI models for conversational AI, text generation, function calling, vision or audio tasks, and structured JSON outputs. Supports reasoning models and tool use.Input Parameters
Output
Create Completion (Legacy)
Create Completion (Legacy)
OPENAI_CREATE_COMPLETIONGenerate single-turn text completions using OpenAI’s legacy Completions API with an available compatible model.Input Parameters
Output
Create Container
Create Container
OPENAI_CREATE_CONTAINERTool to create a new container with configurable memory, expiration, file access, and network policies. Use when you need to provision an isolated execution environment.Input Parameters
Output
Create Container File
Create Container File
Create Conversation
Create Conversation
OPENAI_CREATE_CONVERSATIONTool to create a new conversation for multi-turn interactions. Use when initializing a persistent conversation with optional starter messages.Input Parameters
Output
Create Conversation Items
Create Conversation Items
Create Decision
Create Decision
OPENAI_CREATE_DECISIONEvaluate evidence with typed predicate, choice, and score questions. Each call costs at most $2.Instant: Supported on the latest version.Instant pricing: $0.10 per 1M input tokens ($0.20 long context); cache and output free; $2 max.Input Parameters
Output
Create Embeddings
Create Embeddings
OPENAI_CREATE_EMBEDDINGSTool to generate text embeddings via the OpenAI embeddings endpoint. Use for search, clustering, recommendations, and vector database storage workflows.Input Parameters
Output
Create Eval
Create Eval
OPENAI_CREATE_EVALTool to create an evaluation structure for testing a model’s performance. An evaluation is a set of testing criteria and data source config that dictates the schema of data used in the evaluation. Use when setting up automated testing for model outputs with graders like label_model, string_check, or text_similarity.Input Parameters
Output
Create Evaluation Run
Create Evaluation Run
OPENAI_CREATE_EVAL_RUNCreates an evaluation run for testing with a specified data source and model configuration. OpenAI has scheduled existing evals to become read-only on October 31, 2026, and the Evals API to shut down on November 30, 2026.Input Parameters
Output
Create fine-tuning job
Create fine-tuning job
OPENAI_CREATE_FINE_TUNING_JOBCreates a fine-tuning job from an uploaded training dataset and returns job details and status. Creation is restricted to eligible existing customers; OpenAI says active existing customers will no longer be able to create new jobs starting January 6, 2027.Input Parameters
Output
Generate Image
Generate Image
OPENAI_CREATE_IMAGETool to generate an image via the OpenAI Images API and return hosted image asset URL and metadata. Use when you need to create images from text descriptions for single-shot image generation.Input Parameters
Output
Edit Image
Edit Image
OPENAI_CREATE_IMAGE_EDITTool to create edited or extended images via OpenAI Images Edit API. Use when you need to modify existing images based on a text prompt, with optional mask support for targeted edits.Input Parameters
Output
Create Image Variation
Create Image Variation
OPENAI_CREATE_IMAGE_VARIATIONCreate alternative versions of an existing square PNG image using the legacy image variations operation, with options for count, size, and response format. DEPRECATED: Its documented model, DALL-E 2, shut down on May 12, 2026; OpenAI recommends GPT Image models as replacements.Input Parameters
Output
Create Message
Create Message
OPENAI_CREATE_MESSAGECreate a message in an Assistants conversation thread. This adds the message without triggering a model response; a separate run was needed for an assistant reply. DEPRECATED: The Assistants API was shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
file_id (from OPENAI_UPLOAD_FILE) and a recognized tool name; missing or unknown tool names cause validation failures.Output
Create Moderation
Create Moderation
OPENAI_CREATE_MODERATIONTool to classify text and/or image inputs for potentially harmful content via the OpenAI Moderation API. Use for content safety checks, filtering user-generated content, or monitoring for policy violations across 13 harm categories including harassment, hate, violence, sexual content, self-harm, and illicit activities.Input Parameters
Output
Create Realtime Call
Create Realtime Call
OPENAI_CREATE_REALTIME_CALLCreates a Realtime API call over WebRTC and returns the SDP answer needed to complete the peer connection. A call ID is returned when it can be extracted from the Location header.Input Parameters
Output
Create Realtime Client Secret
Create Realtime Client Secret
OPENAI_CREATE_REALTIME_CLIENT_SECRETTool to create an ephemeral client secret for authenticating Realtime API connections. Use when you need to establish a WebSocket connection to OpenAI’s Realtime API for voice or streaming interactions.Input Parameters
Output
Create Realtime Session
Create Realtime Session
OPENAI_CREATE_REALTIME_SESSIONTool to create an ephemeral API token for client-side Realtime API applications. Use when setting up browser-based real-time audio/text interactions.Input Parameters
Output
Create Realtime Transcription Session
Create Realtime Transcription Session
OPENAI_CREATE_REALTIME_TRANSCRIPTION_SESSIONTool to create an ephemeral API token for realtime transcriptions via the Realtime API. Use when you need to authenticate browser clients for realtime audio transcription sessions. Returns a session object with a client_secret containing a usable ephemeral API token.Input Parameters
Output
Create Response
Create Response
OPENAI_CREATE_RESPONSECreates a model response via the Responses API for text or image analysis and structured JSON output. Returns selected response fields including the ID and output array; aggregated output text may be absent.Input Parameters
Output
Create Run
Create Run
OPENAI_CREATE_RUNCreate an assistant run on an existing thread to execute the assistant and generate responses, optionally adding messages and setting run options. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses and Conversations APIs.Input Parameters
Output
Create Skill
Create Skill
OPENAI_CREATE_SKILLTool to create a skill from uploaded files. Use when you need to create a new skill with SKILL.md and supporting files.Input Parameters
Output
Create Speech (TTS)
Create Speech (TTS)
OPENAI_CREATE_SPEECHTool to generate text-to-speech audio using OpenAI’s Audio API. Use when you need to convert text to natural-sounding speech with a choice of voices and models. Returns a hosted audio file URL with metadata, not raw bytes.Input Parameters
Output
Create Thread
Create Thread
OPENAI_CREATE_THREADCreate an Assistants API conversation thread with optional starter messages and metadata. The thread ID identifies the conversation for subsequent operations. DEPRECATED: The Assistants API was shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
role (‘user’ or ‘assistant’) and a non-empty string content; missing or invalid values will reject the request.Output
Create Thread And Run
Create Thread And Run
Create Upload
Create Upload
OPENAI_CREATE_UPLOADTool to create an intermediate Upload object for large file uploads. Use when uploading files larger than the direct upload limit by adding Parts to the Upload. The Upload accepts up to 8 GB total and expires after one hour if not completed.Input Parameters
Output
Create Vector Store
Create Vector Store
OPENAI_CREATE_VECTOR_STORETool to create a new vector store. Use when you need to create a collection of processed files for file_search tools.Input Parameters
Output
Create Vector Store File
Create Vector Store File
OPENAI_CREATE_VECTOR_STORE_FILETool to create a vector store file by attaching a File to a vector store. Use when you need to add files to a vector store for file search capabilities.Input Parameters
Output
Create vector store file batch
Create vector store file batch
OPENAI_CREATE_VECTOR_STORE_FILE_BATCHTool to create a vector store file batch. Use when attaching multiple files to a vector store for file search capabilities.Input Parameters
Output
Create Video
Create Video
OPENAI_CREATE_VIDEOCreate an asynchronous video generation job from a text prompt using the OpenAI Videos API; the job ID and status were used to track generation. DEPRECATED: The Videos API was shut down on September 24, 2026.Input Parameters
Output
Create Video Remix
Create Video Remix
OPENAI_CREATE_VIDEO_REMIXSubmit a remix job for an existing generated video using a new prompt. OpenAI’s Videos API was shut down on September 24, 2026.Input Parameters
Output
Delete assistant
Delete assistant
Delete chat completion
Delete chat completion
Delete container
Delete container
Delete container file
Delete container file
Delete conversation
Delete conversation
Delete conversation item
Delete conversation item
Delete evaluation
Delete evaluation
Delete evaluation run
Delete evaluation run
Delete file
Delete file
Delete message
Delete message
Delete response
Delete response
Delete skill
Delete skill
Delete thread
Delete thread
Delete Vector Store
Delete Vector Store
Delete Vector Store File
Delete Vector Store File
Delete video
Delete video
Download file
Download file
Download Video Content
Download Video Content
OPENAI_DOWNLOAD_VIDEODownload a generated video’s MP4 content or its thumbnail or spritesheet by video ID. DEPRECATED: OpenAI’s Videos API shut down on September 24, 2026; OpenAI does not list a replacement for it.Input Parameters
Output
Get Chat Completion
Get Chat Completion
Get Chat Completion Messages
Get Chat Completion Messages
OPENAI_GET_CHAT_COMPLETION_MESSAGESTool to retrieve messages from a stored chat completion. Use when you need to fetch the conversation history of a previously created chat completion. Only works with completions that were created with the store parameter set to true.Input Parameters
Output
Get ChatKit thread
Get ChatKit thread
Get Conversation Item
Get Conversation Item
Get Eval
Get Eval
Get Evaluation Run
Get Evaluation Run
Get Eval Run Output Item
Get Eval Run Output Item
Get eval run output items
Get eval run output items
Get Evaluation Runs
Get Evaluation Runs
OPENAI_GET_EVAL_RUNSTool to get a paginated list of runs for an evaluation. Use when you need to retrieve all runs or check the status of multiple runs for a specific evaluation.Input Parameters
Output
Get Input Token Counts
Get Input Token Counts
OPENAI_GET_INPUT_TOKEN_COUNTSTool to calculate input token counts for OpenAI API requests. Use when you need to estimate token usage before making an API call, validate content fits within model limits, or optimize prompts for token efficiency.Input Parameters
Output
Get Message
Get Message
Get Response
Get Response
OPENAI_GET_RESPONSETool to retrieve a model response by ID. Use when you need to check the status, output, or metadata of a previously created response.Input Parameters
Output
Get Run Step
Get Run Step
OPENAI_GET_RUN_STEPRetrieve a specific Assistants run step by thread, run, and step ID to inspect execution progress, tool calls, or message creation. File search result content can be requested. DEPRECATED: The Assistants API was shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
Get Vector Store
Get Vector Store
Get Vector Store File
Get Vector Store File
Get Vector Store File Batch
Get Vector Store File Batch
Get Video
Get Video
OPENAI_GET_VIDEORetrieve a video generation job by ID to inspect its status, progress, and details. DEPRECATED: OpenAI’s Videos API was shut down on September 24, 2026.Input Parameters
Output
List Assistants
List Assistants
OPENAI_LIST_ASSISTANTSList Assistants API assistants to discover an assistant ID from returned names or metadata. Results support cursor pagination, creation-time ordering, and page sizes of 1–100. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
List Batches
List Batches
OPENAI_LIST_BATCHESTool to list your organization’s batches. Use when you need to view all batches, check batch statuses, or find a specific batch by listing them.Input Parameters
Output
List Chat Completions
List Chat Completions
OPENAI_LIST_CHAT_COMPLETIONSTool to list stored chat completions that were created with the store parameter set to true. Use to retrieve previously stored completions for review, analysis, or audit purposes.Input Parameters
Output
List ChatKit thread items
List ChatKit thread items
List container files
List container files
List Containers
List Containers
OPENAI_LIST_CONTAINERSList a page of containers, optionally filtering by name. Use the pagination cursor to retrieve further results.Input Parameters
Output
List Conversation Items
List Conversation Items
OPENAI_LIST_CONVERSATION_ITEMSList a page of items in a conversation by ID for review or processing. Use the pagination cursor to retrieve further items.Input Parameters
web_search_call.action.sources, code_interpreter_call.outputs, computer_call_output.output.image_url, file_search_call.results, message.input_image.image_url, message.output_text.logprobs, reasoning.encrypted_content.Output
List engines
List engines
List Evals
List Evals
List files
List files
OPENAI_LIST_FILESLists files in the authenticated organization/project context. Results are cursor-paginated; use the returned last ID as the next request’s after cursor when more results are available.Input Parameters
Output
List Files in Vector Store Batch
List Files in Vector Store Batch
OPENAI_LIST_FILES_IN_VECTOR_STORE_BATCHTool to list vector store files in a batch. Use when you need to retrieve all files that were added to a vector store as part of a specific batch operation.Input Parameters
Output
List fine-tunes
List fine-tunes
List fine-tuning job events
List fine-tuning job events
List fine-tuning job checkpoints
List fine-tuning job checkpoints
OPENAI_LIST_FINE_TUNING_JOB_CHECKPOINTSTool to list checkpoints for a fine-tuning job. Use when you need to retrieve model checkpoints created during the fine-tuning process. Checkpoints are created at various steps during training and can be used to evaluate model performance at different stages.Input Parameters
Output
List Input Items
List Input Items
OPENAI_LIST_INPUT_ITEMSTool to retrieve input items for a given response from the OpenAI Responses API. Use when you need to inspect the inputs that were used to generate a specific response.Input Parameters
Output
List Messages
List Messages
OPENAI_LIST_MESSAGESList messages in an Assistants thread, including outputs generated by a run. Results can be filtered by run and paginated using cursors, with a page size of 1–100 and creation-time ordering. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
List models
List models
List Runs
List Runs
OPENAI_LIST_RUNSList a page of Assistants runs belonging to a thread to inspect their status or execution history. The legacy operation supports ordering and cursor pagination. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses and Conversations APIs.Input Parameters
Output
List Run Steps
List Run Steps
OPENAI_LIST_RUN_STEPSList steps in an Assistants API run to inspect execution progress, tool calls, and message creation events. Supports pagination, ordering, and optional file search result content. DEPRECATED: The Assistants API was shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
List Skills
List Skills
List ChatKit Threads
List ChatKit Threads
List Vector Store Files
List Vector Store Files
OPENAI_LIST_VECTOR_STORE_FILESTool to list files in a vector store. Use when you need to retrieve all files attached to a specific vector store.Input Parameters
Output
List Vector Stores
List Vector Stores
OPENAI_LIST_VECTOR_STORESTool to list vector stores to discover available vector stores by name or metadata. Use when you need to view all vector stores in your organization.Input Parameters
Output
List Videos
List Videos
Modify Assistant
Modify Assistant
OPENAI_MODIFY_ASSISTANTModify an existing Assistants API assistant’s configuration, such as its model, instructions, tools, or metadata. DEPRECATED: The Assistants API was shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
Modify Message
Modify Message
OPENAI_MODIFY_MESSAGEModify metadata on a specific message in an Assistants conversation thread, identified by thread and message IDs. DEPRECATED: The Assistants API was shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
Modify Run
Modify Run
OPENAI_MODIFY_RUNUpdate metadata on a specific Assistants run identified by its thread and run IDs. DEPRECATED: The Assistants API was shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
Modify thread
Modify thread
OPENAI_MODIFY_THREADUpdate metadata on an existing Assistants API thread identified by its thread ID. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
Modify Vector Store
Modify Vector Store
OPENAI_MODIFY_VECTOR_STORETool to modify an existing vector store. Use when you need to update the name, expiration policy, or metadata of a vector store.Input Parameters
Output
Retrieve assistant
Retrieve assistant
OPENAI_RETRIEVE_ASSISTANTRetrieve a specific assistant by ID to inspect its configuration and metadata. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses and Conversations APIs.Input Parameters
Output
Retrieve Batch
Retrieve Batch
Retrieve container
Retrieve container
Retrieve container file
Retrieve container file
Retrieve container file content
Retrieve container file content
Retrieve engine
Retrieve engine
Retrieve file
Retrieve file
Retrieve fine-tuning job
Retrieve fine-tuning job
Retrieve model
Retrieve model
OPENAI_RETRIEVE_MODELTool to retrieve details of a specific model, confirming its metadata (ownership, created date) and verifying access under your org — a model appearing in OPENAI_LIST_MODELS does not guarantee access. Use before depending on a model ID in downstream calls.Input Parameters
Output
Retrieve run
Retrieve run
OPENAI_RETRIEVE_RUNRetrieve an Assistants run by thread and run ID to check its status, errors, and usage, such as when polling for completion before reading thread messages. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses and Conversations APIs.Input Parameters
Output
Retrieve thread
Retrieve thread
OPENAI_RETRIEVE_THREADRetrieve an Assistants API thread by ID to inspect its metadata; message bodies are obtained separately. DEPRECATED: The Assistants API shut down on August 26, 2026. Migrate to the Responses API and Conversations API.Input Parameters
Output
Retrieve Vector Store File Content
Retrieve Vector Store File Content
Run grader
Run grader
OPENAI_RUN_GRADERTool to run a grader to evaluate model performance on a given sample. Use when you need to evaluate model outputs against expected results using various grading strategies like string matching, text similarity, custom Python code, or model-based scoring.Input Parameters
Output
Search Vector Store
Search Vector Store
OPENAI_SEARCH_VECTOR_STORETool to search a vector store for relevant chunks based on a query and file attributes filter. Use when you need to find specific content within a vector store for retrieval-augmented generation (RAG) or custom search workflows.Input Parameters
Output
Submit Tool Outputs to Run
Submit Tool Outputs to Run
OPENAI_SUBMIT_TOOL_OUTPUTS_TO_RUNSubmit all tool call outputs together to continue an Assistants API run whose required action is submit_tool_outputs. DEPRECATED: The Assistants API shut down on August 26, 2026; migrate to the Responses API and Conversations API.Input Parameters
Output
Update Chat Completion
Update Chat Completion
OPENAI_UPDATE_CHAT_COMPLETIONTool to update metadata for a stored chat completion. Use when you need to modify tags or metadata for a completion that was created with store=true.Input Parameters
Output
Update Conversation
Update Conversation
OPENAI_UPDATE_CONVERSATIONTool to update a conversation’s metadata. Use when you need to modify metadata for an existing conversation.Input Parameters
Output
Update Eval
Update Eval
Update Vector Store File Attributes
Update Vector Store File Attributes
OPENAI_UPDATE_VECTOR_STORE_FILE_ATTRIBUTESTool to update custom attributes on a vector store file. Use when you need to add or modify metadata associated with files in a vector store.Input Parameters
Output
Upload file
Upload file
Validate grader configuration
Validate grader configuration
OPENAI_VALIDATE_GRADERTool to validate a grader configuration for fine-tuning jobs. Use when you need to verify that a grader is correctly configured before using it in a fine-tuning job.