# OpenAI API docs > Guides and conceptual documentation for building with the OpenAI API. Each entry has a Markdown twin at `/api/docs/.md`. ## Documentation sets - [Combined API docs](https://developers.openai.com/api/docs/llms-full.txt): Single-file Markdown export of API guides and docs. ## Actions - [Data retrieval with GPT Actions](https://developers.openai.com/api/docs/actions/data-retrieval.md): Learn about performing data retrieval using APIs, relational databases, and vector databases with GPT Actions. - [Getting started with GPT Actions](https://developers.openai.com/api/docs/actions/getting-started.md): Learn how to set up and test GPT actions from scratch with the OpenAI API. - [GPT Action authentication](https://developers.openai.com/api/docs/actions/authentication.md): Learn about authentication options for GPT actions, including no authentication, API key, and OAuth methods. - [GPT Actions](https://developers.openai.com/api/docs/actions/introduction.md): Learn about GPT Actions for customizing ChatGPT and interacting with external applications via APIs. - [GPT Actions library](https://developers.openai.com/api/docs/actions/actions-library.md): Learn how to build and integrate GPT Actions for common applications using OpenAI's guidance. - [Production notes on GPT Actions](https://developers.openai.com/api/docs/actions/production.md): Guidelines for deploying GPT Actions in a production environment, including rate limits, timeouts, and security measures. - [Sending and returning files with GPT Actions](https://developers.openai.com/api/docs/actions/sending-files.md): Learn how to send and return files using GPT Actions in the OpenAI API. ## Assistants - [Assistants migration guide](https://developers.openai.com/api/docs/assistants/migration.md): Migrate from the retired Assistants API to the Responses API, with side-by-side comparisons and updated patterns. ## Bots - [Overview of OpenAI Crawlers](https://developers.openai.com/api/docs/bots.md) ## Changelog - [API changelog](https://developers.openai.com/api/docs/changelog.md): Customer-visible changes to the OpenAI API and models. ## Concepts - [Key concepts](https://developers.openai.com/api/docs/concepts.md): Key concepts to understand when working with the OpenAI API. ## Deprecations - [Deprecations](https://developers.openai.com/api/docs/deprecations.md): Find information about OpenAI API deprecations and recommended replacements. ## Gpts - [GPT Release Notes](https://developers.openai.com/api/docs/gpts/release-notes.md): Keep track of updates to OpenAI GPTs and explore new features and capabilities in the release notes. ## Guides - [Actions in ChatKit](https://developers.openai.com/api/docs/guides/chatkit-actions.md): Embed a widget to build your own chat experiences. - [Add custom MCP server](https://developers.openai.com/api/docs/guides/custom-mcp-server.md): Connect an MCP server to ChatGPT as a plugin with read and write tools. - [Admin APIs](https://developers.openai.com/api/docs/guides/admin-apis.md): Use Admin APIs and Admin API keys to automate organization management tasks such as invitations and audit log retrieval. - [Advanced integrations with ChatKit](https://developers.openai.com/api/docs/guides/custom-chatkit.md): Use your own server with ChatKit to integrate agent workflows into your product with more customization. - [Advanced usage](https://developers.openai.com/api/docs/guides/advanced-usage.md): Discover advanced usage techniques for OpenAI's API, including reproducible outputs, token management, and parameter settings. - [Agent Builder](https://developers.openai.com/api/docs/guides/agent-builder.md): Use the OpenAI Agent Builder to start from templates, compose nodes, preview runs, and export workflows to code. - [Agent definitions](https://developers.openai.com/api/docs/guides/agents/define-agents.md): Learn how to define an agent's instructions, model, tools, and local context in the OpenAI Agents SDK. - [Agents](https://developers.openai.com/api/docs/guides/agents.md): Compare the Agents API, Agents SDK, and Responses API, then choose the guide for your application. - [Agents API](https://developers.openai.com/api/docs/guides/agents-api/overview.md): Build durable cloud agents with a managed Codex harness. - [Agents API quickstart](https://developers.openai.com/api/docs/guides/agents-api/quickstart.md): Create an agent that writes and runs a script in an OpenAI-hosted sandbox. - [Agents SDK](https://developers.openai.com/api/docs/guides/agents/sdk.md): Learn how the OpenAI Agents SDK fits together and which docs to read next. - [API deployment checklist](https://developers.openai.com/api/docs/guides/deployment-checklist.md): Review commonly underused Responses API design choices that improve deployment quality, speed, cost, and reliability. - [API organization blocking](https://developers.openai.com/api/docs/guides/organization-blocking.md): Configure an allowlist of API organizations through your proxy or Secure Access Service Edge (SASE) service. - [Apply Patch](https://developers.openai.com/api/docs/guides/tools-apply-patch.md): Allow models to propose structured diffs that your integration applies. - [Architecture](https://developers.openai.com/api/docs/guides/agents-api/architecture.md): Understand the harness, environment, and application server, from agents without an environment to agents that use your own compute. - [Async tool calling](https://developers.openai.com/api/docs/guides/async-tool-calling.md): Start asynchronous tool calls, deliver results later, and let the model wait for specific results when needed. - [Audio and voice](https://developers.openai.com/api/docs/guides/audio.md): Start with GPT-Live for conversational voice, or choose an API for another audio task. - [Audio in Chat Completions](https://developers.openai.com/api/docs/guides/audio-chat-completions.md): Add audio input and output to an existing Chat Completions application. - [AWS Lambda MicroVMs](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/aws.md): Connect an AWS Lambda MicroVM to an Agents API session with runtime credentials from AWS Secrets Manager. - [Background mode](https://developers.openai.com/api/docs/guides/background.md): Run long running tasks asynchronously in the background. - [Batch API](https://developers.openai.com/api/docs/guides/batch.md): Learn how to use OpenAI's Batch API for processing jobs with asynchronous requests, increased rate limits, and cost efficiency. - [Bedrock Managed Agents](https://developers.openai.com/api/docs/guides/agents-api/bedrock-managed-agents.md): Understand how Bedrock Managed Agents uses the Agents API on AWS, and compare execution environments and authentication. - [Blaxel](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/blaxel.md): Run an Agents API session in a Blaxel sandbox. - [Browser and desktop drivers](https://developers.openai.com/api/docs/guides/tools-computer-use-sdk-drivers.md): Implement browser reads, actions, approval, and desktop screenshots. Learn which methods the SDK calls and how to recover after an interrupted run. - [ChatKit](https://developers.openai.com/api/docs/guides/chatkit.md): Embed a widget to build your own chat experiences. - [ChatKit widgets](https://developers.openai.com/api/docs/guides/chatkit-widgets.md): Learn how to design widgets in your chat experience with ChatKit. - [Citation Formatting](https://developers.openai.com/api/docs/guides/citation-formatting.md): Learn practical citation formatting patterns that help models generate reliable citations. - [Cloudflare](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/cloudflare.md): Use OpenAI webhooks to start and reconnect Cloudflare sandbox containers. - [Code generation](https://developers.openai.com/api/docs/guides/code-generation.md): Learn how to use OpenAI models and Codex to generate code. - [Code Interpreter](https://developers.openai.com/api/docs/guides/tools-code-interpreter.md): Allow models to write and run Python to solve problems. - [Codex federation rule reference](https://developers.openai.com/api/docs/guides/workload-identity-federation/federation-rules.md): Reference for Codex workload identity subjects, audiences, exact claims, CEL conditions, scopes, token lifetimes, and lifecycle behavior. - [Compaction](https://developers.openai.com/api/docs/guides/compaction.md): Manage long-running conversations with server-side and standalone compaction. - [Completions API](https://developers.openai.com/api/docs/guides/completions.md) - [Computer use](https://developers.openai.com/api/docs/guides/agents-api/tools/computer-use.md): Run a browser task, handle website approvals and sign-in, and recover an Agents API session. - [Computer use](https://developers.openai.com/api/docs/guides/tools-computer-use.md): Use the Python or Node SDK to run a browser or desktop task, or connect your own runtime through the Responses API. - [Computer use integration recipes](https://developers.openai.com/api/docs/guides/tools-computer-use-integration.md): Environment setup, action handlers, custom execution services, and consent guidance for computer use integrations. - [Configure workload identity federation with X.509 certificates](https://developers.openai.com/api/docs/guides/workload-identity-federation/x509.md): Configure an X.509 workload identity provider and exchange a TLS client certificate for a short-lived OpenAI access token. - [Configuring Agents](https://developers.openai.com/api/docs/guides/agents-api/configuration.md): Define an agent, reuse its configuration, and customize each session. - [Configuring workload identity federation for AWS](https://developers.openai.com/api/docs/guides/workload-identity-federation/aws.md): Configure AWS outbound identity federation or Amazon EKS as a workload identity federation token provider. - [Configuring workload identity federation for GitHub Actions](https://developers.openai.com/api/docs/guides/workload-identity-federation/github-actions.md): Configure GitHub Actions as a workload identity federation token provider. - [Configuring workload identity federation for Google Cloud](https://developers.openai.com/api/docs/guides/workload-identity-federation/google-cloud.md): Configure Google workload identity or GKE as a workload identity federation token provider. - [Configuring workload identity federation for Idira](https://developers.openai.com/api/docs/guides/workload-identity-federation/idira.md): Authenticate Idira Secure Workload Access workloads to the OpenAI API with SPIFFE JWT-SVIDs. - [Configuring workload identity federation for Kubernetes](https://developers.openai.com/api/docs/guides/workload-identity-federation/kubernetes.md): Configure Kubernetes as a workload identity federation token provider. - [Configuring workload identity federation for Microsoft Azure](https://developers.openai.com/api/docs/guides/workload-identity-federation/microsoft-azure.md): Configure Azure managed identity or AKS as a workload identity federation token provider. - [Configuring workload identity federation for Oracle Cloud Infrastructure](https://developers.openai.com/api/docs/guides/workload-identity-federation/oracle-cloud.md): Configure Oracle Cloud Infrastructure instance principals as a workload identity federation token provider. - [Configuring workload identity federation for SPIFFE](https://developers.openai.com/api/docs/guides/workload-identity-federation/spiffe.md): Configure SPIFFE JWT-SVIDs as workload identity federation subject tokens. - [Connect voice to Decisions](https://developers.openai.com/api/docs/guides/decisions-voice.md): Use the native Decisions integration in GPT-Live to choose an action or react to an input or output transcript. - [Content provenance](https://developers.openai.com/api/docs/guides/content-provenance.md): Learn how to verify images and audio and use provenance results responsibly. - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state.md): Learn how to manage conversation state during a model interaction with the OpenAI API. - [Cost optimization](https://developers.openai.com/api/docs/guides/cost-optimization.md): Lower your OpenAI model costs by trying our tools and strategies. - [Cost optimization](https://developers.openai.com/api/docs/guides/voice-latency-cost.md): Understand voice usage and manage costs for GPT-Live and the Realtime API. - [Counting tokens](https://developers.openai.com/api/docs/guides/token-counting.md): Use the Responses API to count input tokens for text, images, files, tools, and more—without estimation or tiktoken. - [CSAM guidance](https://developers.openai.com/api/docs/guides/csam-guidance.md): Learn practical guidance for addressing CSAM risks in products built with OpenAI. - [Custom voices](https://developers.openai.com/api/docs/guides/custom-voices.md): Create a voice from a text prompt for GPT-Live, or use an approved recording for speech generation and voice agents. - [Cybersecurity checks](https://developers.openai.com/api/docs/guides/safety-checks/cybersecurity.md): Learn about API cybersecurity safeguards, authorized access, request-level checks, access restrictions, and appeals. - [Data controls in the OpenAI platform](https://developers.openai.com/api/docs/guides/your-data.md): Your data is your data. An overview of how OpenAI uses your data, including retention and usage policies. - [Daytona](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/daytona.md): Run an Agents API session in a Daytona Sandbox. - [Decisions](https://developers.openai.com/api/docs/guides/decisions.md): Use the Decisions API to check conditions, select from fixed options, and score text and images against a rubric. - [Deep research](https://developers.openai.com/api/docs/guides/deep-research.md): Use deep research models for complex analysis and research tasks. - [Delegation and tools in GPT-Live](https://developers.openai.com/api/docs/guides/live-delegation.md): Configure GPT-Live client or Responses delegation, use hosted tools, return tool results and approvals, and reduce backend latency. - [DigitalOcean](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/digitalocean.md): Connect a DigitalOcean sandbox to an Agents API session. - [Direct preference optimization](https://developers.openai.com/api/docs/guides/direct-preference-optimization.md): Fine-tune models for subjective decision-making by comparing model outputs. - [E2B](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/e2b.md): Connect an E2B sandbox to an Agents API session. - [Error codes](https://developers.openai.com/api/docs/guides/error-codes.md): An overview of error codes from the OpenAI API and Python library, including solutions and guidance. - [Errors and recovery](https://developers.openai.com/api/docs/guides/agents-api/errors.md): Identify Agents API request, turn, session, and environment errors, and choose when to fix input, retry, or start a new session. - [Evaluate agent workflows](https://developers.openai.com/api/docs/guides/agent-evals.md): Learn how to evaluate agent workflows with traces, graders, datasets, and evaluation runs on the OpenAI platform. - [Evaluate external models](https://developers.openai.com/api/docs/guides/external-models.md): Learn how to run evals on non-OpenAI models, using the OpenAI platform. - [Evaluation best practices](https://developers.openai.com/api/docs/guides/evaluation-best-practices.md): Learn best practices for designing evals to test and improve model performance in production. - [Events and items](https://developers.openai.com/api/docs/guides/agents-api/sessions/events.md): Consume live updates and retrieve saved work. - [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode.md): Get up to 2.5× faster speeds in the API while retaining flexible pay-as-you-go pricing. - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs.md): Learn how to use files as file inputs in the OpenAI API. - [File search](https://developers.openai.com/api/docs/guides/tools-file-search.md): Allow models to search your files for relevant information before generating a response. - [File transcription](https://developers.openai.com/api/docs/guides/speech-to-text.md): Learn how to transcribe recorded audio files, stream file transcripts, and use specialized speech-to-text features. - [Files and artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files.md): Retrieve files from your environment and preserve published outputs. - [Fine-tuning best practices](https://developers.openai.com/api/docs/guides/fine-tuning-best-practices.md): Improve results with practical tips for fine-tuning. - [Flex processing](https://developers.openai.com/api/docs/guides/flex-processing.md): Learn how to optimize costs for asynchronous tasks with flex processing. - [Frontend prompt instructions](https://developers.openai.com/api/docs/guides/frontend-prompt.md): Example prompt instructions for frontend work, written for GPT-5.5. - [Function calling](https://developers.openai.com/api/docs/guides/function-calling.md): Learn how function calling enables large language models to connect to external data and systems. - [Functions](https://developers.openai.com/api/docs/guides/agents-api/tools/functions.md): Define functions, handle pending calls, and return results. - [Get started with Promptfoo](https://developers.openai.com/api/docs/guides/promptfoo-codex.md): Evaluate AI applications with Promptfoo. Run a sample eval in the CLI or set one up with Codex. - [Getting started with datasets](https://developers.openai.com/api/docs/guides/evaluation-getting-started.md): Learn how to get started with evals using datasets. - [Getting started with GPT-Live](https://developers.openai.com/api/docs/guides/live.md): Build with GPT-Live, choose a backend, and connect your first browser voice session. - [Getting started with the Realtime API](https://developers.openai.com/api/docs/guides/realtime.md): Build a browser voice agent with the Realtime API and Agents SDK. - [GPT-Live partner integrations](https://developers.openai.com/api/docs/guides/live-partner-integrations.md): Choose a GPT-Live integration for LiveKit, Twilio, Telnyx, Bandwidth, or Daily/Pipecat. - [Graders](https://developers.openai.com/api/docs/guides/graders.md): Learn about graders used for evals and fine-tuning. - [Guardrails and human review](https://developers.openai.com/api/docs/guides/agents/guardrails-approvals.md): Learn how to use guardrails and human review in the OpenAI Agents SDK for safer, more controlled workflows. - [Image generation](https://developers.openai.com/api/docs/guides/image-generation.md): Learn how to generate or edit images with the OpenAI API and image generation models. - [Image generation](https://developers.openai.com/api/docs/guides/tools-image-generation.md): Allow models to generate or edit images. - [Image input token and cost calculator](https://developers.openai.com/api/docs/guides/image-cost-calculator.md): Estimate image input tokens and API costs for OpenAI vision models by model, image dimensions, and detail level. - [Image prompting](https://developers.openai.com/api/docs/guides/image-prompting.md): Explore GPT Image prompting techniques and illustrated generation and editing examples. - [Images and vision](https://developers.openai.com/api/docs/guides/images-vision.md): Learn how to understand or generate images with the OpenAI API. - [Import and reconcile OpenAI resources](https://developers.openai.com/api/docs/guides/terraform/import-and-reconcile.md): Import existing OpenAI resources into Terraform, inspect current state, reconcile drift, and understand removal behavior. - [Integrations and observability](https://developers.openai.com/api/docs/guides/agents/integrations-observability.md): Learn how to integrate MCP into Agents SDK workflows and how to trace and debug runs. - [IP allowlist](https://developers.openai.com/api/docs/guides/ip-allowlist.md): Configure organization- or project-level IP allowlists for OpenAI API requests. - [IP egress ranges](https://developers.openai.com/api/docs/guides/ip-addresses.md): Find the published IP egress ranges used by OpenAI products. - [Latency optimization](https://developers.openai.com/api/docs/guides/latency-optimization.md): Improve latency across a wide variety of LLM-related use cases. - [Local shell](https://developers.openai.com/api/docs/guides/tools-local-shell.md): Enable agents to run commands in a local shell. - [Manage permissions in the OpenAI platform](https://developers.openai.com/api/docs/guides/rbac.md): Learn how to use role-based access control to assign permissions, create custom roles, group users, and scope access across both the OpenAI API and dashboard. - [Manage projects and access with Terraform](https://developers.openai.com/api/docs/guides/terraform/projects-and-access.md): Create an OpenAI project, define least-privilege roles, and manage group and user access with Terraform. - [Manage service accounts with Terraform](https://developers.openai.com/api/docs/guides/terraform/service-accounts.md): Create OpenAI project service accounts, assign least-privilege roles, and manage API keys outside Terraform state. - [Manage sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage.md): Find sessions, handle required actions, and delete saved work. - [Managing GPT-Live sessions](https://developers.openai.com/api/docs/guides/live-conversations.md): Configure GPT-Live sessions, provide history and context, build transcript and microphone controls, and handle long conversations, errors, and recovery. - [MCP connections](https://developers.openai.com/api/docs/guides/agents-api/tools/mcp.md): Connect MCP servers from OpenAI or your environment. - [MCP servers](https://developers.openai.com/api/docs/guides/tools-connectors-mcp.md): Use remote MCP servers or Secure MCP Tunnel to give models access to external tools. - [Mid-turn steering](https://developers.openai.com/api/docs/guides/steering.md): Steer a Responses API workflow over WebSockets, follow continuations, and handle queued input and tool results. - [Migrate from Agent Builder](https://developers.openai.com/api/docs/guides/agent-builder/migrate-from-agent-builder.md): Learn how to export an Agent Builder workflow and continue with ChatGPT Workspace Agents or the Agents SDK. - [Migrate from prompt objects](https://developers.openai.com/api/docs/guides/prompting/migrate-from-prompt-object.md): Learn how to migrate from reusable prompt objects to versioned prompts in your application code. - [Migrate to GPT-Live](https://developers.openai.com/api/docs/guides/live-migration.md): Adapt your voice interface, backend tools, and application state to GPT-Live, with migration paths for Realtime and existing text agents. - [Migrate to the Responses API](https://developers.openai.com/api/docs/guides/migrate-to-responses.md) - [Misalignment monitoring](https://developers.openai.com/api/docs/guides/safety-checks/misalignment-monitoring.md): Understand misalignment monitoring coverage, handle blocked requests, and receive project safety alerts in your application. - [Modal](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/modal.md): Run an Agents API session in a Modal Sandbox. - [Model optimization](https://developers.openai.com/api/docs/guides/model-optimization.md): Ensure quality model outputs with evals and fine-tuning in the OpenAI platform. - [Model selection](https://developers.openai.com/api/docs/guides/model-selection.md): Find the right model for your use case - [Model, tool, and data controls with Terraform](https://developers.openai.com/api/docs/guides/terraform/project-controls.md): Manage OpenAI project model permissions, hosted-tool permissions, and data-retention controls with Terraform. - [Models and providers](https://developers.openai.com/api/docs/guides/agents/models.md): Learn how to choose models, set defaults, and think about providers and transport in the OpenAI Agents SDK. - [Moderation](https://developers.openai.com/api/docs/guides/moderation.md): Learn how to identify harmful content in text and images with OpenAI moderation models. - [Multi-agent](https://developers.openai.com/api/docs/guides/agents-api/multi-agent.md): Let an agent delegate work to independent subagents. - [Multi-agent](https://developers.openai.com/api/docs/guides/responses-multi-agent.md): Enable Responses API Multi-agent, handle client-side HTTP and WebSocket flows, and read Multi-agent output items. - [Mutual TLS](https://developers.openai.com/api/docs/guides/mutual-tls.md): Configure Mutual TLS trust, certificate verification, CEL filters, rotation, and troubleshooting for OpenAI API requests. - [Node reference](https://developers.openai.com/api/docs/guides/node-reference.md): Explore all available nodes for composing workflows in Agent Builder. - [Observability and usage](https://developers.openai.com/api/docs/guides/agents-api/observability.md): Inspect live progress, completed work, and recorded token usage. - [OpenAI on Amazon Bedrock](https://developers.openai.com/api/docs/guides/amazon-bedrock.md): Compare OpenAI model inference on Amazon Bedrock with the OpenAI API, and find AWS setup guidance. - [OpenAI-hosted sandboxes](https://developers.openai.com/api/docs/guides/agents-api/environments/openai-hosted.md): Run code and create downloadable files without managing compute. - [Optimizing LLM Accuracy](https://developers.openai.com/api/docs/guides/optimizing-llm-accuracy.md): Learn strategies to enhance the accuracy of large language models using techniques like prompt engineering, retrieval-augmented generation, and fine-tuning. - [Oracle Cloud Infrastructure (OCI)](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/oci.md): Connect an OCI GenAI Sandbox to an Agents API session. - [Orchestration and handoffs](https://developers.openai.com/api/docs/guides/agents/orchestration.md): Learn how to orchestrate multiple agents with handoffs and agents-as-tools in the OpenAI Agents SDK. - [Plugins](https://developers.openai.com/api/docs/guides/agents-api/tools/plugins.md): Package skills and MCP configuration for use across sessions. - [Pre-warm sandboxes](https://developers.openai.com/api/docs/guides/agents-api/environments/prewarmed.md): Prepare a workspace before starting an agent session. - [Predicted Outputs](https://developers.openai.com/api/docs/guides/predicted-outputs.md): Understand how to reduce latency for model responses where much of the response is known ahead of time. - [Private Link](https://developers.openai.com/api/docs/guides/private-link.md): Configure Azure Private Link endpoints, DNS, health checks, and cross-region routing for the OpenAI API. - [Production best practices](https://developers.openai.com/api/docs/guides/production-best-practices.md): Explore best practices for transitioning your AI projects from prototype to production, including scaling, security, and cost management. - [Programmatic Tool Calling](https://developers.openai.com/api/docs/guides/tools-programmatic-tool-calling.md): Configure Programmatic Tool Calling, control which tools programs can invoke, and resume programs after client-owned function calls. - [Prompt cache diagnostics](https://developers.openai.com/api/docs/guides/prompt-caching/diagnostics.md): Compare Responses API requests to understand prompt cache misses and improve cache reuse. - [Prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching.md): Learn how prompt caching reduces latency and cost for long prompts in OpenAI's API. - [Prompt engineering](https://developers.openai.com/api/docs/guides/prompt-engineering.md): Learn strategies and tactics for better results using large language models in the OpenAI API. - [Prompt generation](https://developers.openai.com/api/docs/guides/prompt-generation.md): Learn how to generate prompts, functions, and schemas in the OpenAI API's Playground. - [Prompt optimizer](https://developers.openai.com/api/docs/guides/prompt-optimizer.md): Learn how to use your dataset to automatically improve your prompts. - [Prompting](https://developers.openai.com/api/docs/guides/prompting.md): Learn how to create, optimize, and maintain prompts with OpenAI models. - [Prompting GPT-Live](https://developers.openai.com/api/docs/guides/live-prompting.md): Prompt GPT-Live for conversation style, backchannels, interruptions, and delegation. - [Prompting guidance for GPT-5.6 Sol](https://developers.openai.com/api/docs/guides/prompt-guidance-gpt-5p6.md): Machine-readable prompting guidance for adapting prompts and agents to GPT-5.6 Sol. - [Prompting Realtime models](https://developers.openai.com/api/docs/guides/voice-prompting.md): Design and test prompts for Realtime voice models. - [Quickstart](https://developers.openai.com/api/docs/guides/agents/quickstart.md): Build your first agent with the OpenAI Agents SDK, add tools and handoffs, and understand where to go next. - [Rate limits](https://developers.openai.com/api/docs/guides/rate-limits.md): Rate limits are restrictions that our API imposes on the number of times a user or client can access our services within a specified period of time. - [Rate limits and spend with Terraform](https://developers.openai.com/api/docs/guides/terraform/rate-limits-and-spend.md): Discover and manage OpenAI project rate limits and create organization or project spend alerts with Terraform. - [Realtime conversations](https://developers.openai.com/api/docs/guides/realtime-conversations.md): Learn how to manage Realtime speech-to-speech conversations. - [Realtime transcription](https://developers.openai.com/api/docs/guides/realtime-transcription.md): Learn how to transcribe live audio with realtime transcription sessions. - [Realtime translation](https://developers.openai.com/api/docs/guides/realtime-translation.md): Learn how to build live speech translation with Realtime translation sessions. - [Realtime with tools](https://developers.openai.com/api/docs/guides/realtime-mcp.md): Learn how to configure function tools and MCP tools in a Realtime session. - [Reasoning best practices](https://developers.openai.com/api/docs/guides/reasoning-best-practices.md): Explore best practices for using o-series reasoning models, like o1 and o3-mini, vs. GPT models—including use cases, how to choose a model, and prompting guidance. - [Reasoning models](https://developers.openai.com/api/docs/guides/reasoning.md): Learn how to use OpenAI reasoning models in the Responses API, choose a reasoning effort, manage reasoning tokens, and keep reasoning state across turns. - [Red teaming](https://developers.openai.com/api/docs/guides/red-teaming.md): Learn how red teaming fits into AI evaluation, including Promptfoo open source and OpenAI Red Teaming for enterprise teams. - [Reinforcement fine-tuning](https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning.md): Fine-tune models for expert-level performance within a domain. - [Reinforcement fine-tuning use cases](https://developers.openai.com/api/docs/guides/rft-use-cases.md): Explore best practices and practical use cases for reinforcement fine-tuning (RFT) with OpenAI models. - [Results and state](https://developers.openai.com/api/docs/guides/agents/results.md): Learn which result surfaces matter most in the OpenAI Agents SDK and how they connect to resumable workflow state. - [Retrieval](https://developers.openai.com/api/docs/guides/retrieval.md): Learn how to search your data using semantic similarity with the OpenAI API. - [Run and continue sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions.md): Start work, follow progress, and continue the conversation. - [Running agents](https://developers.openai.com/api/docs/guides/agents/running-agents.md): Learn how to run agents, stream output, and choose the right conversation-state strategy in the OpenAI Agents SDK. - [Safety best practices](https://developers.openai.com/api/docs/guides/safety-best-practices.md): Learn how to implement safety measures like moderation, adversarial testing, human oversight, and prompt engineering to ensure responsible AI deployment. - [Safety classifiers](https://developers.openai.com/api/docs/guides/safety-checks.md): Learn how API safety classifiers identify potential abuse and how safety identifiers help limit disruption to other users. - [Safety enforcement notifications](https://developers.openai.com/api/docs/guides/safety-enforcement.md): Receive organization-level safety webhooks, retrieve case details, and connect enforcement notices to your application's users. - [Safety in building agents](https://developers.openai.com/api/docs/guides/agent-builder-safety.md): Minimize prompt injections and other risks when building agent workflows with OpenAI Agent Builder. - [Sandbox Agents](https://developers.openai.com/api/docs/guides/agents/sandboxes.md): Learn how sandboxes fit into Agents SDK workflows, when to use them, and how orchestration stays separate from execution. - [Sandbox lifecycle](https://developers.openai.com/api/docs/guides/agents-api/environments/lifecycle.md): Start, reconnect, and stop your agent's environment. - [Sandbox security](https://developers.openai.com/api/docs/guides/agents-api/environments/security.md): Isolate workloads, restrict network access, and protect credentials. - [Secure MCP Tunnel](https://developers.openai.com/api/docs/guides/secure-mcp-tunnels.md): Connect private or on-prem MCP servers to supported OpenAI products with an outbound-only MCP tunnel, without exposing them to the public internet. - [Self-hosted sandboxes](https://developers.openai.com/api/docs/guides/agents-api/environments/self-hosted.md): Connect your compute and files to an agent session. - [Server-side controls](https://developers.openai.com/api/docs/guides/voice-server-controls.md): Keep session control and private tool execution on your server. - [Session webhooks](https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks.md): React to agent lifecycle changes. - [Shell](https://developers.openai.com/api/docs/guides/tools-shell.md): Run shell commands in hosted containers or your own local runtime. - [Skills](https://developers.openai.com/api/docs/guides/tools-skills.md): Create reusable skills for Responses API shell tools and Agents API sandboxes. - [Spend limits](https://developers.openai.com/api/docs/guides/spend-limits.md): Control API spend with organization and project monthly spend limits. - [Streaming API responses](https://developers.openai.com/api/docs/guides/streaming-responses.md): Learn how to stream model responses from the OpenAI API using server-sent events. - [Structured model outputs](https://developers.openai.com/api/docs/guides/structured-outputs.md): Understand how to ensure model responses follow specific JSON Schema you define. - [Supervised fine-tuning](https://developers.openai.com/api/docs/guides/supervised-fine-tuning.md): Fine-tune models with example inputs and known good outputs for better results and efficiency. - [Telephony and SIP](https://developers.openai.com/api/docs/guides/voice-sip.md): Choose a SIP connection or an application audio bridge for phone calls. - [Terraform provider](https://developers.openai.com/api/docs/guides/terraform.md): Configure the OpenAI Terraform provider and manage organization resources through the Administration API. - [Text generation](https://developers.openai.com/api/docs/guides/text.md): Learn how to use the OpenAI API to generate text from a prompt. Learn about message types and available text formats like JSON and Structured Outputs. - [Text to speech](https://developers.openai.com/api/docs/guides/text-to-speech.md): Learn how to turn text into lifelike spoken audio with the OpenAI API. - [Theming and customization in ChatKit](https://developers.openai.com/api/docs/guides/chatkit-themes.md): Configure colors, typography, density, and component variants in your ChatKit implementation. - [Tool search](https://developers.openai.com/api/docs/guides/tools-tool-search.md): Use tool search to defer large tool surfaces, group related tools with namespaces, and load only the relevant functions at runtime. - [Trace grading](https://developers.openai.com/api/docs/guides/trace-grading.md): Use trace grading to create datasets, configure graders, and track evaluation runs for your models. - [Tracing](https://developers.openai.com/api/docs/guides/agents-api/tracing.md): Inspect agent activity in the dashboard and export session traces as OTLP JSON. - [Transcription](https://developers.openai.com/api/docs/guides/transcription.md): Choose between file transcription and realtime transcription, then start with the recommended model for your audio. - [Ultrafast mode](https://developers.openai.com/api/docs/guides/ultrafast-mode.md): Use Ultrafast mode with GPT-6 Astra and GPT-6.1 Sol over WebSockets, with SDK examples and an HTTP alternative. - [Under-18 guidance](https://developers.openai.com/api/docs/guides/safety-checks/under-18-api-guidance.md): Review regulatory standards, safety standards, and best practices for API applications that serve users under 18. - [Upgrading to GPT-5.4](https://developers.openai.com/api/docs/guides/upgrading-to-gpt-5p4.md): Guidance for upgrading OpenAI API model strings and directly related prompts to GPT-5.4. - [Upgrading to GPT-5.5](https://developers.openai.com/api/docs/guides/upgrading-to-gpt-5p5.md): Guidance for upgrading OpenAI API model strings and directly related prompts to GPT-5.5. - [Upgrading to GPT-5.6 Sol](https://developers.openai.com/api/docs/guides/upgrading-to-gpt-5p6-sol.md): Machine-readable guidance for migrating OpenAI API integrations to GPT-5.6 Sol and the GPT-5.6 family. - [Use Daybreak in the Responses API](https://developers.openai.com/api/docs/guides/daybreak.md): Choose compatible models and Daybreak access programs, understand default behavior, and handle errors in the Responses API. - [Using GPT-4.1](https://developers.openai.com/api/docs/guides/latest-model/gpt-4.1.md): Learn how to use, migrate to, and prompt GPT-4.1 in the OpenAI API. - [Using GPT-5](https://developers.openai.com/api/docs/guides/latest-model/gpt-5.md): Learn how to use, migrate to, and prompt GPT-5 in the OpenAI API. - [Using GPT-5.1](https://developers.openai.com/api/docs/guides/latest-model/gpt-5.1.md): Learn how to use, migrate to, and prompt GPT-5.1 in the OpenAI API. - [Using GPT-5.2](https://developers.openai.com/api/docs/guides/latest-model/gpt-5.2.md): Learn how to use, migrate to, and prompt GPT-5.2 in the OpenAI API. - [Using GPT-5.3-Codex](https://developers.openai.com/api/docs/guides/latest-model/gpt-5.3-codex.md): Learn how to use, migrate to, and prompt GPT-5.3-Codex in the Responses API. - [Using GPT-5.4](https://developers.openai.com/api/docs/guides/latest-model/gpt-5.4.md): Learn how to use, migrate to, and prompt GPT-5.4 in the OpenAI API. - [Using GPT-5.5](https://developers.openai.com/api/docs/guides/latest-model/gpt-5.5.md): Learn how to use and migrate to GPT-5.5 in the OpenAI API. - [Using GPT-5.6](https://developers.openai.com/api/docs/guides/latest-model/gpt-5.6.md): Learn how to use and migrate to GPT-5.6, the latest model family in the OpenAI API. - [Using GPT-6](https://developers.openai.com/api/docs/guides/latest-model/gpt-6-astra.md): Learn how to use GPT-6 Astra, GPT-6.1 Sol, GPT-6 Sol, and GPT-6 Luna for reasoning, coding, professional work, and tool-using workflows, and how to migrate from GPT-5.6. - [Using tools](https://developers.openai.com/api/docs/guides/tools.md): Use powerful tools like remote MCP servers, or built-in tools like web search and file search to extend the model's capabilities. - [Vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults.md): Store secrets for MCPs or requests originating from the sandbox. - [Vector embeddings](https://developers.openai.com/api/docs/guides/embeddings.md): Learn how to turn text into numbers, unlocking use cases like search, clustering, and more with OpenAI API embeddings. - [Vercel](https://developers.openai.com/api/docs/guides/agents-api/environments/providers/vercel.md): Run an Agents API session in a Vercel Sandbox. - [Vision fine-tuning](https://developers.openai.com/api/docs/guides/vision-fine-tuning.md): Fine-tune models for better image understanding. - [Voice activity detection (VAD)](https://developers.openai.com/api/docs/guides/realtime-vad.md): Learn about automatic voice activity detection in the Realtime API. - [Voice agents](https://developers.openai.com/api/docs/guides/voice-agents.md): Choose a voice architecture and connect spoken conversations to your agent workflows. - [Web search](https://developers.openai.com/api/docs/guides/agents-api/tools/web-search.md): Use OpenAI's built-in web search to find information. - [Web search](https://developers.openai.com/api/docs/guides/tools-web-search.md): Allow models to search the web for the latest information before generating a response. - [Webhooks](https://developers.openai.com/api/docs/guides/webhooks.md): Use webhooks to receive real-time updates from the OpenAI API. - [WebRTC](https://developers.openai.com/api/docs/guides/voice-webrtc.md): Connect voice applications with WebRTC. - [WebRTC with WARP](https://developers.openai.com/api/docs/guides/realtime-webrtc-warp.md): Learn how to enable WARP optimizations for native and browser-based GPT-Live and Realtime API clients. - [WebSocket Mode](https://developers.openai.com/api/docs/guides/websocket-mode.md): Learn how to use Responses API WebSocket mode with response creation, continuation, and multiplexing. - [WebSockets](https://developers.openai.com/api/docs/guides/voice-websockets.md): Connect server-owned audio streams over WebSockets. - [Working with evals](https://developers.openai.com/api/docs/guides/evals.md): Learn how to test and improve AI model outputs through evaluations. - [Workload identity federation](https://developers.openai.com/api/docs/guides/workload-identity-federation.md): Authenticate trusted workloads to the OpenAI API and Codex with short-lived identity-provider tokens. - [ZDR with Private Safety Processing](https://developers.openai.com/api/docs/guides/private-safety-processing.md): ZDR with Private Safety Processing ## Libraries - [SDKs and CLI](https://developers.openai.com/api/docs/libraries.md): Discover official OpenAI SDKs, the OpenAI CLI, and the Agents SDK. - [OpenAI CLI](https://developers.openai.com/api/docs/libraries/openai-cli.md): Install and use the generated OpenAI command-line tool for Responses, structured outputs, images, speech, and shell workflows. ## Mcp - [Building MCP servers for plugins and API integrations](https://developers.openai.com/api/docs/mcp.md): Learn how to build MCP servers for use with plugins, deep research, or API integrations. ## Models - [Models](https://developers.openai.com/api/docs/models.md): Catalog of models available through the OpenAI API. - [All models](https://developers.openai.com/api/docs/models/all.md): Browse the complete OpenAI API model catalog. - [Compare models](https://developers.openai.com/api/docs/models/compare.md): Compare model capabilities, context windows, and pricing. ## Pricing - [Pricing](https://developers.openai.com/api/docs/pricing.md): Pricing information for the OpenAI platform. ## Quickstart - [Developer quickstart](https://developers.openai.com/api/docs/quickstart.md): Learn how to use the OpenAI API to generate human-like responses to natural language prompts, analyze images with computer vision, use powerful built-in tools, and more. ## Supported Countries - [Supported countries and territories](https://developers.openai.com/api/docs/supported-countries.md): Countries and territories that currently support access to our API services. ## Tutorials - [Meeting minutes](https://developers.openai.com/api/docs/tutorials/meeting-minutes.md): Create an automated meeting minutes generator with speech-to-text and a GPT model. - [Web QA with embeddings](https://developers.openai.com/api/docs/tutorials/web-qa-embeddings.md): How to build an AI that can answer questions about your website.