Add OpenAI to your AI agent

Tool to create a fine-tuning job which begins the process of creating a new model from a given dataset. Use when you need to start fine-tuning a model with your training data. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

Tool 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.

Tool 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.

Tool to create a variation of a given image using the OpenAI Images API. Use when you need to generate alternative versions of an existing image. Only supports dall-e-2 model.

Tool to create a new message in a specific thread. Appends the message only — does not trigger a model response; create a separate run to obtain assistant replies. Use when adding messages to an existing conversation after confirming the thread ID.

Tool 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.

Tool 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.

Tool to create an ephemeral API token for client-side Realtime API applications. Use when setting up browser-based real-time audio/text interactions.

Tool 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.

Tool to generate a one-shot model response via the Responses API. Use for multimodal analysis (image + text), OCR/text extraction from images, or structured JSON outputs. For structured outputs, configure text.format with type='json_schema' and your schema. Returns the full Response object including id, output array, and aggregated output_text for parsing structured data.

Tool to create a run on a thread with an assistant. Use when you need to execute an assistant to generate responses. Creating a message alone does not cause the assistant to respond; a run is the execution primitive. After creating the run, typically poll the run status until it reaches a terminal state (completed, failed, cancelled, expired), then read the assistant's messages from the thread.

Tool to create a skill from uploaded files. Use when you need to create a new skill with SKILL.md and supporting files.

Tool 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.

Tool to create a new thread. Use when initializing a conversation with optional starter messages. Returns a thread_id that must be persisted and passed to all subsequent calls (e.g., OPENAI_CREATE_MESSAGE, OPENAI_RETRIEVE_THREAD). Create a fresh thread for each independent conversation or unrelated task.

Tool to create a thread and run it in one request. Use when you need to start a new conversation and immediately execute the assistant to generate a response. This is more efficient than calling create_thread and create_run separately.

Tool 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.

Tool to create a new vector store. Use when you need to create a collection of processed files for file_search tools.

Tool 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.

Tool to create a video using Sora models via the OpenAI Videos API. Use when you need to generate videos from text descriptions. The response includes a job ID and status for tracking the asynchronous video generation process.

Tool to create a video remix from an existing generated video using OpenAI's Video API. Use when you need to transform or modify a previously generated video based on a new prompt. The remix operation creates a new video job that applies the new prompt to the original video content.

Tool to delete a specific assistant by its ID. Use when you need to remove an assistant after confirming its ID. Deletion is irreversible and permanently removes all assistant configuration.

Tool to delete a conversation by its ID. Items in the conversation will not be deleted. Use when you need to remove a conversation.

Tool to delete a file by its ID after confirming the target. Files persist indefinitely and count against storage quotas; periodically list and remove unneeded files to avoid hitting file-count or size caps.

Tool to delete a thread by its ID. Use when you need to remove a conversation thread after confirming the target ID.

Tool to delete a vector store. Use when you need to permanently remove a vector store by its ID.

Tool to delete a video by its ID. Use when you need to remove a video after confirming its identifier.

Tool to retrieve a stored chat completion. Use when you need to fetch a previously created chat completion that was stored with store=true.

Tool to get a list of output items for an evaluation run. Use when you need to retrieve the detailed results of an eval run, including grading outcomes, input/output samples, and token usage.

Tool 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.

Tool to retrieve a specific message from a thread by its ID. Use when you need to fetch details of a particular message in an Assistants thread.

Tool to retrieve a vector store by its ID. Use when you need to get details of an existing vector store for file_search operations.

Tool to retrieve a file from a vector store. Use when you need to check the status or details of a file attached to a vector store.

Tool to list assistants to discover the correct assistant_id by name or metadata. Use when assistant_id is unknown to avoid 404 errors.

Tool 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.

Tool to list evaluations for a project. Use when you need to view all evaluations, check their configurations, or find a specific evaluation by listing them.

Tool to retrieve a list of files uploaded to your organization/project context. Cursor-paginated: continue requesting pages until next_cursor is null to retrieve all files. Files from other project environments are not visible. Cached file_ids may become stale if files are deleted; re-query before referencing file_ids in downstream workflows.

Tool to list your organization's fine-tuning jobs. Use when you need to review all fine-tune runs. Results are scoped to the authenticated organization; an empty list means no fine-tunes exist for that org specifically.

Tool to list messages in an Assistants thread to fetch the assistant's generated outputs after a run completes. Use after polling a run to completion to retrieve assistant responses.

Tool to list available models scoped to the current account/organization — some public models may be absent due to permissions. Use when you need to discover which models you can call. Results may include deprecated or assistant-incompatible models; confirm a specific model's status via OPENAI_RETRIEVE_MODEL before using it in OPENAI_CREATE_ASSISTANT or other calls. Use model IDs exactly as returned — misspelled or unsupported IDs cause validation errors. Models vary in capability (vision, file-based features, context size); inspect metadata before assuming support. Filter results by id, owned_by, or status to handle large result sets efficiently.

Tool to list run steps for an Assistants API run to track detailed execution progress, inspect tool calls, and view message creation events. Use after creating a run to monitor its step-by-step execution or to retrieve tool call details after completion. When polling to monitor active runs, use reasonable intervals to avoid rate-limit errors.

Tool to list files in a vector store. Use when you need to retrieve all files attached to a specific vector store.

Tool to modify an existing assistant. Use when you need to update an assistant's configuration, model, instructions, tools, or metadata.

Tool to modify a run's metadata. Use when you need to update metadata information for a specific run.

Tool to modify an existing thread's metadata. Use after obtaining the thread ID when you need to update metadata.

Tool to retrieve details of a specific assistant. Use when you need to confirm assistant metadata before performing further operations. Prefer this over repeated OPENAI_CREATE_ASSISTANT calls to avoid cluttering assistant configurations.

Tool to retrieve a batch by ID to check its status, progress, and results. Use when you need to check the current state of a batch job, view completion statistics, or access output file IDs.

Tool to retrieve details of a specific container by its ID. Use when you need to fetch container configuration, status, or metadata.

Tool to retrieve information about a specific file. Use when you need to check the details, status, or metadata of a file by its ID.

Tool to retrieve information about a fine-tuning job. Use when you need to check the status, progress, or details of an existing fine-tuning job.

Tool 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.

Tool to retrieve an Assistants run by ID to check status, errors, and usage. Use when polling run status until it reaches a terminal state (completed, failed, cancelled, incomplete, expired) before reading thread messages.

Tool to retrieve metadata of a specific thread by its ID — does not include message bodies or assistant replies (those require a completed run and separate message listing). Use before listing messages. After thread creation or message appending, wait 2–3 seconds before polling; use exponential backoff (1s, 2s, 4s) for HTTP 429 responses. Avoid concurrent OPENAI_CREATE_MESSAGE writes during retrieval to prevent inconsistent message states.

Tool 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.

Tool to submit tool call outputs to continue a run that requires action. Use when a run has status 'requires_action' and required_action.type is 'submit_tool_outputs'. All tool outputs must be submitted together in a single request.

Tool to upload a file for use across OpenAI endpoints. Use before referencing the file in tasks like fine-tuning. Returns a `file_id` that must be explicitly passed to endpoints like OPENAI_CREATE_ASSISTANT or OPENAI_CREATE_MESSAGE — uploaded files are not auto-discovered. Files exceeding size limits return HTTP 413; split or compress oversized content before retrying. Verify uploads via OPENAI_LIST_FILES before referencing `file_id`, as unsupported formats may be silently rejected. Repeated uploads accumulate against storage quotas; delete unused files with OPENAI_DELETE_FILE.

Tool 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.

Tool 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.

Tool to cancel an upload. Use when you need to stop an upload that is in progress. No parts may be added after cancellation.

Tool 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.

Tool 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.

Tool to generate text completions using OpenAI's legacy Completions API. Use for single-turn text generation with models like gpt-3.5-turbo-instruct. Note: This endpoint is legacy; prefer Chat Completions for newer models.

Tool to create a file in a container. Use when adding files to an existing container either by referencing an uploaded file ID or by uploading raw file content directly.

Tool to create a Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection. Use when initiating a bidirectional audio/data WebRTC session with OpenAI's Realtime API. Returns the SDP answer and call ID for connection establishment.

Tool to create a vector store file batch. Use when attaching multiple files to a vector store for file search capabilities.

Tool to delete a stored chat completion by its ID. Use when you need to remove a chat completion that was created with store=true.

Tool to delete a specific container by its ID. Use when you need to remove a container after confirming its ID.

Tool to delete a file from a container. Use when you need to remove a file from a specific container by providing both container ID and file ID.

Tool to delete an item from a conversation with the given IDs. Use when you need to remove a specific message or item from a conversation.

Tool to delete a specific evaluation by its ID. Use when you need to remove an evaluation after confirming its ID.

Tool to delete an evaluation run. Use when you need to permanently remove a specific run from an evaluation.

Tool to delete a message from a thread. Use when you need to remove a specific message by its ID after confirming both the thread and message IDs.

Tool to delete a model response with the given ID. Use when you need to remove a stored response from the Responses API.

Tool to delete a specific skill by its ID. Use when you need to remove a skill after confirming its ID.

Tool to delete a vector store file. This removes the file from the vector store but does not delete the file itself. Use when you need to remove a file from a vector store's search index.

Tool to download the contents of a specified file by its ID. Use when you need to retrieve file content from OpenAI.

Tool to download video content (MP4) or preview assets from OpenAI Videos API. Use when you need to retrieve the actual video file, thumbnail, or spritesheet for a generated video.

Tool 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.

Tool to retrieve a ChatKit thread by its ID. Use when you need to fetch details about a specific ChatKit thread including its status, title, and owner.

Tool to retrieve a single item from a conversation. Use when you need to fetch details of a specific message or item within a conversation.

Tool to retrieve an evaluation by ID. Use when you need to inspect an existing evaluation's configuration, data source settings, or testing criteria.

Tool to retrieve an evaluation run by ID to check status and results. Use when you need to monitor an evaluation run's progress or retrieve its final results after creation.

Tool to retrieve a specific output item from an evaluation run by its ID. Use when you need detailed results for a particular test case within an evaluation run.

Tool 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.

Tool to retrieve a model response by ID. Use when you need to check the status, output, or metadata of a previously created response.

Tool to retrieve a specific run step from an Assistants API run to inspect detailed execution progress, view tool calls, or check message creation. Use when you need details about a specific step in a run's execution.

Tool to retrieve a vector store file batch. Use when you need to check the status of a batch file processing operation.

Tool to retrieve a video generation job by its unique identifier. Use when you need to check the status, progress, or details of a video generation task.

Tool 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.

Tool to list ChatKit thread items. Use when you need to retrieve all items from a ChatKit thread, including messages, tool calls, and tasks.

Tool to list files in a container. Use when you need to view all files uploaded to a specific container.

Tool to list containers. Use when you need to view all containers in your organization or filter by name.

Tool to list all items for a conversation with the given ID. Use when you need to retrieve the items in a conversation for review or processing.

Tool to list available engines and their basic information. Use when you need to discover which engines are available.

Tool 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.

Tool to get status updates for a fine-tuning job. Use when you need to monitor the progress of a fine-tuning job or retrieve event logs.

Tool 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.

Tool 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.

Tool to list runs belonging to a thread. Use when you need to view all runs that have been executed on a specific thread, for example to find a run by status or to track execution history.

Tool to list skills. Use when you need to discover available skills or retrieve skill IDs by name or description.

Tool to list ChatKit threads with pagination and filtering. Use when you need to retrieve threads for a specific user or browse all available threads.

Tool 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.

Tool to list all video generation jobs. Use when you need to view all videos that have been created or check the status of multiple video generation tasks.

Tool to modify an existing message's metadata in a thread. Use when you need to update metadata associated with a specific message.

Tool to modify an existing vector store. Use when you need to update the name, expiration policy, or metadata of a vector store.

Tool to retrieve metadata for a specific file in a container. Use when you need to get details about a container file including its size, path, and creation timestamp.

Tool to retrieve the content of a file within a container. Use when you need to download or access the actual file data from a container.

Tool to retrieve details of a specific engine. Use when you need to confirm engine availability and metadata before using it.

Tool to retrieve the parsed contents of a vector store file. Use when you need to access the actual text content that has been processed and chunked for a file in a vector store.

Tool 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.

Tool 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.

Tool to update a conversation's metadata. Use when you need to modify metadata for an existing conversation.

Tool to update certain properties of an evaluation (name and metadata). Use when you need to rename an evaluation or update its metadata without changing the data source configuration or testing criteria.

Tool 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.

Tool 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.