> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # OpenAI > Toolkit for OpenAI APIs: manage Assistants, Threads/Messages; upload/list/delete Files; list/retrieve Models (including vision/multimodal); and view fine-tune listings and events Toolkit for OpenAI APIs: manage Assistants, Threads/Messages; upload/list/delete Files; list/retrieve Models (including vision/multimodal); and view fine-tune listings and events. `openai` · **126 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth openai run auth openai --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run openai # common commands run openai --all # every command ``` ```ts theme={"theme":"github-dark"} import { openai } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cancel-batch` | Tool to cancel an in-progress batch. Use when you need to stop a batch that is currently processing. | | `cancel-eval-run` | Tool to cancel an ongoing evaluation run. Use when you need to stop an evaluation run that is currently in progress. | | `cancel-run` | 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. | | `create-audio-transcription` | Tool to transcribe audio files to text via OpenAI Audio Transcriptions API. | | `create-batch` | Tool to create and execute a batch from an uploaded file of requests. | | `create-chat-completion` | Tool to create a chat completion response from OpenAI models. | | `create-container` | Tool to create a new container with configurable memory, expiration, file access, and network policies. | | `create-conversation` | Tool to create a new conversation for multi-turn interactions. | | `create-conversation-items` | Tool to create items in a conversation with the given ID. Use when adding messages or other items to an existing conversation. | | `create-embeddings` | Tool to generate text embeddings via the OpenAI embeddings endpoint. | | `create-eval` | Tool to create an evaluation structure for testing a model's performance. | | `create-eval-run` | Tool to create a new evaluation run for testing model configurations. | | `create-fine-tuning-job` | Tool to create a fine-tuning job which begins the process of creating a new model from a given dataset. | | `create-image` | Tool to generate an image via the OpenAI Images API and return hosted image asset URL and metadata. | | `create-image-edit` | Tool to create edited or extended images via OpenAI Images Edit API. | | `create-image-variation` | Tool to create a variation of a given image using the OpenAI Images API. | | `create-message` | 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. | | `create-moderation` | Tool to classify text and/or image inputs for potentially harmful content via the OpenAI Moderation API. | | `create-realtime-client-secret` | Tool to create an ephemeral client secret for authenticating Realtime API connections. | | `create-realtime-session` | Tool to create an ephemeral API token for client-side Realtime API applications. | | `create-realtime-transcription-session` | Tool to create an ephemeral API token for realtime transcriptions via the Realtime API. | | `create-response` | Tool to generate a one-shot model response via the Responses API. | | `create-run` | Tool to create a run on a thread with an assistant. Use when you need to execute an assistant to generate responses. | | `create-skill` | Tool to create a skill from uploaded files. Use when you need to create a new skill with SKILL.md and supporting files. | | `create-speech` | Tool to generate text-to-speech audio using OpenAI's Audio API. | | Tool | What it does | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-upload-part` | 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. | | `cancel-batch` | Tool to cancel an in-progress batch. Use when you need to stop a batch that is currently processing. | | `cancel-eval-run` | Tool to cancel an ongoing evaluation run. Use when you need to stop an evaluation run that is currently in progress. | | `cancel-response` | 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. | | `cancel-run` | 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. | | `cancel-upload` | Tool to cancel an upload. Use when you need to stop an upload that is in progress. | | `compact-response` | Tool to compact a conversation or response to reduce token usage. | | `create-audio-transcription` | Tool to transcribe audio files to text via OpenAI Audio Transcriptions API. | | `create-audio-translation` | Tool to translate audio files to English text via OpenAI Audio Translations API. | | `create-batch` | Tool to create and execute a batch from an uploaded file of requests. | | `create-chat-completion` | Tool to create a chat completion response from OpenAI models. | | `create-completion` | Tool to generate text completions using OpenAI's legacy Completions API. | | `create-container` | Tool to create a new container with configurable memory, expiration, file access, and network policies. | | `create-container-file` | 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. | | `create-conversation` | Tool to create a new conversation for multi-turn interactions. | | `create-conversation-items` | Tool to create items in a conversation with the given ID. Use when adding messages or other items to an existing conversation. | | `create-embeddings` | Tool to generate text embeddings via the OpenAI embeddings endpoint. | | `create-eval` | Tool to create an evaluation structure for testing a model's performance. | | `create-eval-run` | Tool to create a new evaluation run for testing model configurations. | | `create-fine-tuning-job` | Tool to create a fine-tuning job which begins the process of creating a new model from a given dataset. | | `create-image` | Tool to generate an image via the OpenAI Images API and return hosted image asset URL and metadata. | | `create-image-edit` | Tool to create edited or extended images via OpenAI Images Edit API. | | `create-image-variation` | Tool to create a variation of a given image using the OpenAI Images API. | | `create-message` | 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. | | `create-moderation` | Tool to classify text and/or image inputs for potentially harmful content via the OpenAI Moderation API. | | `create-realtime-call` | Tool to create a Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection. | | `create-realtime-client-secret` | Tool to create an ephemeral client secret for authenticating Realtime API connections. | | `create-realtime-session` | Tool to create an ephemeral API token for client-side Realtime API applications. | | `create-realtime-transcription-session` | Tool to create an ephemeral API token for realtime transcriptions via the Realtime API. | | `create-response` | Tool to generate a one-shot model response via the Responses API. | | `create-run` | Tool to create a run on a thread with an assistant. Use when you need to execute an assistant to generate responses. | | `create-skill` | Tool to create a skill from uploaded files. Use when you need to create a new skill with SKILL.md and supporting files. | | `create-speech` | Tool to generate text-to-speech audio using OpenAI's Audio API. | | `create-thread` | Tool to create a new thread. Use when initializing a conversation with optional starter messages. | | `create-thread-and-run` | 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. | | `create-upload` | Tool to create an intermediate Upload object for large file uploads. | | `create-vector-store` | Tool to create a new vector store. Use when you need to create a collection of processed files for file\_search tools. | | `create-vector-store-file` | Tool to create a vector store file by attaching a File to a vector store. | | `create-vector-store-file-batch` | Tool to create a vector store file batch. Use when attaching multiple files to a vector store for file search capabilities. | | `create-video` | Tool to create a video using Sora models via the OpenAI Videos API. | | `create-video-remix` | Tool to create a video remix from an existing generated video using OpenAI's Video API. | | `delete-assistant` | Tool to delete a specific assistant by its ID. Use when you need to remove an assistant after confirming its ID. | | `delete-chat-completion` | 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. | | `delete-container` | Tool to delete a specific container by its ID. Use when you need to remove a container after confirming its ID. | | `delete-container-file` | 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. | | `delete-conversation` | Tool to delete a conversation by its ID. Items in the conversation will not be deleted. | | `delete-conversation-item` | Tool to delete an item from a conversation with the given IDs. | | `delete-eval` | Tool to delete a specific evaluation by its ID. Use when you need to remove an evaluation after confirming its ID. | | `delete-eval-run` | Tool to delete an evaluation run. Use when you need to permanently remove a specific run from an evaluation. | | `delete-file` | Tool to delete a file by its ID after confirming the target. | | `delete-message` | 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. | | `delete-response` | Tool to delete a model response with the given ID. Use when you need to remove a stored response from the Responses API. | | `delete-skill` | Tool to delete a specific skill by its ID. Use when you need to remove a skill after confirming its ID. | | `delete-thread` | Tool to delete a thread by its ID. Use when you need to remove a conversation thread after confirming the target ID. | | `delete-vector-store` | Tool to delete a vector store. Use when you need to permanently remove a vector store by its ID. | | `delete-vector-store-file` | Tool to delete a vector store file. This removes the file from the vector store but does not delete the file itself. | | `delete-video` | Tool to delete a video by its ID. Use when you need to remove a video after confirming its identifier. | | `download-file` | Tool to download the contents of a specified file by its ID. | | `download-video` | Tool to download video content (MP4) or preview assets from OpenAI Videos API. | | `get-chat-completion` | Tool to retrieve a stored chat completion. Use when you need to fetch a previously created chat completion that was stored with store=true. | | `get-chat-completion-messages` | Tool to retrieve messages from a stored chat completion. Use when you need to fetch the conversation history of a previously created chat completion. | | `get-chatkit-thread` | 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. | | `get-conversation-item` | 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. | | `get-eval` | Tool to retrieve an evaluation by ID. Use when you need to inspect an existing evaluation's configuration, data source settings, or testing criteria. | | `get-eval-run` | Tool to retrieve an evaluation run by ID to check status and results. | | `get-eval-run-output-item` | Tool to retrieve a specific output item from an evaluation run by its ID. | | `get-eval-run-output-items` | 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... | | `get-eval-runs` | 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. | | `get-input-token-counts` | Tool to calculate input token counts for OpenAI API requests. | | `get-message` | Tool to retrieve a specific message from a thread by its ID. | | `get-response` | Tool to retrieve a model response by ID. Use when you need to check the status, output, or metadata of a previously created response. | | `get-run-step` | Tool to retrieve a specific run step from an Assistants API run to inspect detailed execution progress, view tool calls, or check message creation. | | `get-vector-store` | 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. | | `get-vector-store-file` | 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. | | `get-vector-store-file-batch` | Tool to retrieve a vector store file batch. Use when you need to check the status of a batch file processing operation. | | `get-video` | Tool to retrieve a video generation job by its unique identifier. | | `list-assistants` | Tool to list assistants to discover the correct assistant\_id by name or metadata. | | `list-batches` | 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. | | `list-chat-completions` | Tool to list stored chat completions that were created with the `store` parameter set to true. | | `list-chatkit-thread-items` | Tool to list ChatKit thread items. Use when you need to retrieve all items from a ChatKit thread, including messages, tool calls, and tasks. | | `list-container-files` | Tool to list files in a container. Use when you need to view all files uploaded to a specific container. | | `list-containers` | Tool to list containers. Use when you need to view all containers in your organization or filter by name. | | `list-conversation-items` | Tool to list all items for a conversation with the given ID. | | `list-engines` | Tool to list available engines and their basic information. Use when you need to discover which engines are available. | | `list-evals` | 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. | | `list-files` | Tool to retrieve a list of files uploaded to your organization/project context. | | `list-files-in-vector-store-batch` | 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. | | `list-fine-tunes` | Tool to list your organization's fine-tuning jobs. Use when you need to review all fine-tune runs. | | `list-fine-tuning-events` | 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. | | `list-fine-tuning-job-checkpoints` | Tool to list checkpoints for a fine-tuning job. Use when you need to retrieve model checkpoints created during the fine-tuning process. | | `list-input-items` | Tool to retrieve input items for a given response from the OpenAI Responses API. | | `list-messages` | Tool to list messages in an Assistants thread to fetch the assistant's generated outputs after a run completes. | | `list-models` | Tool to list available models scoped to the current account/organization - some public models may be absent due to permissions. | | `list-runs` | 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... | | `list-run-steps` | Tool to list run steps for an Assistants API run to track detailed execution progress, inspect tool calls, and view message creation events. | | `list-skills` | Tool to list skills. Use when you need to discover available skills or retrieve skill IDs by name or description. | | `list-threads` | 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. | | `list-vector-store-files` | Tool to list files in a vector store. Use when you need to retrieve all files attached to a specific vector store. | | `list-vector-stores` | Tool to list vector stores to discover available vector stores by name or metadata. | | `list-videos` | 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. | | `modify-assistant` | Tool to modify an existing assistant. Use when you need to update an assistant's configuration, model, instructions, tools, or metadata. | | `modify-message` | Tool to modify an existing message's metadata in a thread. Use when you need to update metadata associated with a specific message. | | `modify-run` | Tool to modify a run's metadata. Use when you need to update metadata information for a specific run. | | `modify-thread` | Tool to modify an existing thread's metadata. Use after obtaining the thread ID when you need to update metadata. | | `modify-vector-store` | Tool to modify an existing vector store. Use when you need to update the name, expiration policy, or metadata of a vector store. | | `retrieve-assistant` | Tool to retrieve details of a specific assistant. Use when you need to confirm assistant metadata before performing further operations. | | `retrieve-batch` | Tool to retrieve a batch by ID to check its status, progress, and results. | | `retrieve-container` | Tool to retrieve details of a specific container by its ID. Use when you need to fetch container configuration, status, or metadata. | | `retrieve-container-file` | Tool to retrieve metadata for a specific file in a container. | | `retrieve-container-file-content` | 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. | | `retrieve-engine` | Tool to retrieve details of a specific engine. Use when you need to confirm engine availability and metadata before using it. | | `retrieve-file` | 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. | | `retrieve-fine-tuning-job` | 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. | | `retrieve-model` | Tool to retrieve details of a specific model, confirming its metadata (ownership, created date) and verifying access under your org - a model... | | `retrieve-run` | Tool to retrieve an Assistants run by ID to check status, errors, and usage. | | `retrieve-thread` | 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... | | `retrieve-vector-store-file-content` | Tool to retrieve the parsed contents of a vector store file. | | `run-grader` | Tool to run a grader to evaluate model performance on a given sample. | | `search-vector-store` | Tool to search a vector store for relevant chunks based on a query and file attributes filter. | | `submit-tool-outputs-to-run` | Tool to submit tool call outputs to continue a run that requires action. | | `update-chat-completion` | 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. | | `update-conversation` | Tool to update a conversation's metadata. Use when you need to modify metadata for an existing conversation. | | `update-eval` | Tool to update certain properties of an evaluation (name and metadata). | | `update-vector-store-file-attributes` | 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. | | `upload-file` | Tool to upload a file for use across OpenAI endpoints. Use before referencing the file in tasks like fine-tuning. | | `validate-grader` | Tool to validate a grader configuration for fine-tuning jobs. | [Open OpenAI in the console →](https://app.boxd.sh/integrations/detail/openai)