OpenAI

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.

Untrusted display-only summary

Tool to cancel an in-progress batch. Use when you need to stop a batch that is currently processing. The batch will be in status 'cancelling' for up to 10 minutes before changing to 'cancelled', where partial results (if any) will be available.

Untrusted display-only summary

Tool to cancel an ongoing evaluation run. Use when you need to stop an evaluation run that is currently in progress.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to cancel a run that is currently in progress. Use when you need to stop an assistant run that is taking too long or is no longer needed. The run's status will transition to 'cancelling' and then 'cancelled'.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to transcribe audio files to text via OpenAI Audio Transcriptions API. Use when you need to convert speech in audio files to written text, optionally with timestamps or speaker diarization.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

Tool to create a chat completion response from OpenAI models. Use for conversational AI, text generation, function calling, multimodal tasks with vision/audio, and structured JSON outputs. Supports advanced features like reasoning models, tool use, and streaming responses.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to create a new container with configurable memory, expiration, file access, and network policies. Use when you need to provision an isolated execution environment.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to create a new conversation for multi-turn interactions. Use when initializing a persistent conversation with optional starter messages.

Untrusted display-only summary

Tool to create items in a conversation with the given ID. Use when adding messages or other items to an existing conversation.

Untrusted display-only summary

Tool to generate text embeddings via the OpenAI embeddings endpoint. Use for search, clustering, recommendations, and vector database storage workflows.

Untrusted display-only summary

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

Untrusted display-only summary

Tool to create a new evaluation run for testing model configurations. Use when you need to kick off an evaluation with a specific data source and model configuration to test.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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,…

Untrusted display-only summary