Skip to content
ChatGPT
Home
API
Docs
Guides and concepts for the OpenAI API
API reference
Endpoints, parameters, and responses
Codex
Docs
Guides, concepts, and product docs for Codex
Use cases
Example workflows and tasks teams can take on with ChatGPT or Codex
Docs
Use cases
Resources
ChatGPT
Apps SDK
Build apps to extend ChatGPT
Workspace Agents
Trigger published ChatGPT workspace agents
Commerce
Build commerce flows in ChatGPT
Ads
Publish and measure ads in ChatGPT
Resources
Showcase
Demo apps to get inspired
Blog
Learnings and experiences from developers
Cookbook
Notebook examples for building with OpenAI models
Learn
Docs, videos, and demo apps for building with OpenAI
Community
Programs, meetups, and support for builders
Start searching
API Dashboard
Try ChatGPT
Search the API docs
Search docs
Suggested
responses create
reasoning_effort
realtime
prompt caching
Primary navigation
API
API Reference
Codex
ChatGPT
Docs
Use cases
Resources
Resources
Search docs
Suggested
responses create
reasoning_effort
realtime
prompt caching
Get started
Overview
Quickstart
Models
Pricing
SDKs and CLI
OpenAI SDK
Agents SDK
OpenAI CLI
Using GPT-5.6
Core concepts
Text generation
Code generation
Images and vision
Audio and speech
Structured output
Function calling
Responses API
Using tools
Agents SDK
Overview
Quickstart
Agent definitions
Models and providers
Running agents
Sandbox agents
Orchestration
Guardrails
Results and state
Integrations and observability
Evaluate agent workflows
Voice agents
ChatKit
Overview
Customize
Widgets
Actions
Advanced integrations
Tools
Web search
MCP and Connectors
Secure MCP Tunnel
Skills
Shell
Computer use
File search and retrieval
File search
Retrieval
Tool search
Programmatic tool calling
More tools
Apply Patch
Local shell
Image generation
Code interpreter
Run and scale
Conversation state
Background mode
Streaming
WebSocket mode
Multi-agent
Webhooks
File inputs
Context management
Compaction
Counting tokens
Prompt caching
Prompting
Overview
Prompt engineering
Citation formatting
Migration guide
Reasoning
Reasoning models
Reasoning best practices
Evaluation
Red teaming
Realtime and audio
Overview
Voice agents
Live translation
Transcription
Realtime transcription
Speech to text
Speech generation
Realtime prompting guide
Connection methods
WebRTC
WebSocket
SIP
Realtime sessions
Managing conversations
Voice activity detection
Realtime with tools
Webhooks and server-side controls
Managing costs
Specialized models
Image generation
Video generation
Deep research
Embeddings
Moderation
Going live
Production best practices
Private Link
Workload identity federation
Overview
Kubernetes
AWS
Microsoft Azure
Google Cloud
GitHub Actions
SPIFFE
Deployment checklist
Amazon Bedrock
Latency optimization
Overview
Predicted Outputs
Priority processing
Cost optimization
Overview
Batch
Flex processing
Accuracy optimization
Safety
Safety best practices
Safety checks
Cybersecurity checks
Under 18 API Guidance
Legacy APIs
Agent Builder
Overview
Migration guide
Node reference
Safety in building agents
Evals
Getting started
Working with evals
Prompt optimizer
External models
Best practices
Graders
Fine-tuning
Optimization cycle
Supervised fine-tuning
Vision fine-tuning
Direct preference optimization
Reinforcement fine-tuning
RFT use cases
Best practices
Assistants API
Migration guide
Deep dive
Tools
Resources
Terms and policies
Changelog
Your data
Permissions
Rate limits
IP egress ranges
Admin APIs
Deprecations
MCP for deep research
Developer mode
ChatGPT Actions
Introduction
Getting started
Actions library
Authentication
Production
Data retrieval
Sending files
Docs
Use cases
Docs
Use cases
Docs section
Docs
Apps SDK
Workspace Agents
Commerce
Ads
Apps SDK
Workspace Agents
Commerce
Ads
Docs section
Select...
Home
Quickstart
Core Concepts
MCP Apps in ChatGPT
MCP Server
UX principles
UI guidelines
Plan
Research use cases
Define tools
Design components
Build
Set up your server
Build your ChatGPT UI
Authenticate users
Manage state
Monetize your app
Examples
Deploy
Deploy your app
Connect from ChatGPT
Test your integration
Submit your app
Conversion apps
Restaurant reservation spec
Product checkout spec
Guides
Optimize Metadata
Security & Privacy
Troubleshooting
Resources
Changelog
App submission guidelines
Reference
Home
Get started
Trigger workspace agent runs
Authenticate with Workspace Agent access tokens
Home
Guides
Get started
Best practices
File Upload
Overview
Products
API
Overview
Feeds
Products
Promotions
Ads Overview
Measurement
JavaScript Pixel
Image tag
Conversions API
Supported events
Advertiser API
Overview
Quickstart
Product feeds
Campaign Targeting
API Reference
Authentication
Campaigns
Ad Groups
Ads
Ad Account
Insights
Files
Overview
Features
Configuration
Developers
Security
Administration
Use Cases
Resources
Overview
Features
Configuration
Developers
Security
Administration
Use Cases
Resources
Docs section
Overview
Home
Get started
Quickstart
Use ChatGPT
Get started with Work
Import from another agent
Foundations
Prompting
Personalize ChatGPT
Skills & Plugins
Permissions
Explore
What's new
Models
Pricing
Glossary
Available on
ChatGPT desktop app
ChatGPT on the web
Codex CLI
Codex IDE extension
Codex cloud
Releases
Changelog
Feature Maturity
Open Source
Overview
Workflows
Projects, chats, and tasks
Sites
Visualizations
Scheduled tasks
Long-running work
Notifications
Pets
Capabilities
Browser
Computer use
Plugins
Web search
Image generation
Image inputs
Appshots
Chrome extension
Work with files
Reference
Commands
Slash commands
Settings
Troubleshooting
Overview
Customization
Overview
Memories
Chronicle
Config file
Config Basics
Advanced Config
Config Reference
Environment Variables
Sample Config
Agent configuration
AGENTS.md
Subagents
Speed
Rules
Extend ChatGPT and Codex
Record & Replay
MCP
Windows
Desktop app
Windows sandbox
WSL
Overview
Development workflows
Code review
Integrated terminal
Extend and automate
Build skills
Build plugins
Build an app
Submit plugins
Hooks
Environments
Modes
Local environments
Cloud environment
Git worktrees
Build with Codex
Codex SDK
App Server
MCP Server
GitHub Action
Non-interactive mode
Third-party integrations
GitHub
Slack
Linear
Reference
CLI customization
Developer commands
Developer settings
Overview
Permissions
Profiles
Sandboxing
Auto-review
Agent approvals & security
Internet access
Codex Security
Overview
FAQ
Codex Security plugin
Quickstart
Run a security scan
Run a deep scan
Review code changes
Triage a backlog
Fix findings
Export and track findings
Changelog
Codex Security cloud setup
Improving the threat model
Safety
Cyber Safety
Overview
Getting started
Admin rollout guide
ChatGPT Work Admin FAQ
Identity and authentication
Authentication overview
Access tokens
Workspace access, policy, and models
Groups and provisioning
Roles and workspace permissions
Managed configuration
HIPAA configuration
Workspace model availability
Plugin and connector controls
Plugin controls
Skill controls
Usage, governance, and compliance
Governance
Workspace analytics
Analytics API
Compliance API and audit events
Deployment and model providers
Remote connections
Amazon Bedrock
Explore use cases
Collections
Home
Videos
Showcase
OpenAI Academy
Online trainings
Community
Codex Ambassadors
Codex for Students
Codex for Open Source
Meetups
Blog
Company blog
Developer blog
Explore use cases
Collections
Home
Videos
Showcase
OpenAI Academy
Online trainings
Community
Codex Ambassadors
Codex for Students
Codex for Open Source
Meetups
Blog
Company blog
Developer blog
Showcase
Blog
Cookbook
Learn
Community
Showcase
Blog
Cookbook
Learn
Community
Docs section
Select...
All posts
Recent
Mastering remote engineering work from your phone
Making private MCP servers reachable without making them public
How Perplexity Brought Voice Search to Millions Using the Realtime API
Designing delightful frontends with GPT-5.4
From prompts to products: One year of Responses
Topics
General
API
Apps SDK
Audio
Codex
Home
Topics
Agents
Evals
Multimodal
Text
Guardrails
Optimization
ChatGPT
Codex
gpt-oss
Contribute
Cookbook on GitHub
Home
OpenAI Developers plugin
Docs MCP
Categories
Demo apps
Videos
Topics
Agents
Audio & Voice
Computer Use
Codex
Evals
gpt-oss
Fine-tuning
Image generation
Scaling
Tools
Video generation
Community
Programs
Codex Ambassadors
Codex for Students
Codex for Open Source
OpenAI for Startups
Events
Meetups
Spaces
Developer Forum
Discord
Reddit
X
API Dashboard
Try ChatGPT
API
API Reference
Codex
ChatGPT
Docs
Use cases
Resources
Resources
API Reference
API Reference
Introduction
Authentication
Workload identity tokens
Debugging requests
Backwards compatibility
Responses API
Overview
Responses
Create a response
Retrieve a response
Delete a response
List input items
Count input tokens
Cancel a response
Compact a response
Conversations
Create a conversation
Retrieve a conversation
Update a conversation
Delete a conversation
Items
Create an item
Retrieve an item
Delete an item
List items
Streaming events
WebSocket events
Beta APIs
Responses
Create a response
Retrieve a response
Delete a response
List input items
Count input tokens
Cancel a response
Compact a response
Streaming events
WebSocket events
Webhooks
Events
Unwrap
Platform APIs
Audio
Create a transcription
Create a translation
Create a speech
Videos
Create a video
Create Character
Get Character
Retrieve a video
Delete a video
List videos
Download Content
Edit
Extend
Remix
Images
Generate an Image
Edit an Image
Create Variation
Image generation streaming events
Image edit streaming events
Embeddings
Create an embedding
Evals
Create an eval
Retrieve an eval
Update an eval
Delete an eval
List evals
Runs
Create a run
Retrieve a run
Delete a run
List runs
Cancel a run
Output Items
Retrieve an output item
List output items
Fine Tuning
Jobs
Create a job
Retrieve a job
List jobs
List Events
Cancel a job
Pause
Resume
Checkpoints
List checkpoints
Checkpoints
Permissions
Create a permission
Retrieve a permission
Delete a permission
List permissions
Alpha
Graders
Run
Validate
Batches
Create a batch
Retrieve a batch
List batches
Cancel a batch
Files
List files
Create a file
Retrieve a file
Delete a file
Retrieve file content
Uploads
Create an upload
Cancel an upload
Complete
Parts
Create a part
Models
Retrieve a model
Delete a model
List models
Moderations
Create a moderation
Vector Stores
Vector Stores
Create a vector store
Retrieve a vector store
Update a vector store
Delete a vector store
List vector stores
Search
Files
List files
Create a file
Retrieve a file
Update a file
Delete a file
Retrieve file content
File Batches
Create a file batch
Retrieve a file batch
List Files
Cancel a file batch
ChatKit
Sessions
Create a session
Cancel a session
Threads
Retrieve a thread
Delete a thread
List Items
List threads
Containers
Containers
Create a container
Retrieve a container
Delete a container
List containers
Files
List files
Create a file
Retrieve a file
Delete a file
Content
Retrieve a content
Skills
Skills
Create a skill
Retrieve a skill
Retrieve skill content
Update a skill
Delete a skill
List skills
Versions
Create skill version
Retrieve skill version
Retrieve Skill Version Content
Delete skill version
List skill versions
Realtime
Translations
Translation client events
Translation server events
Client Secrets
Create a client secret
Calls
Accept
Hangup
Refer
Reject
Client events
Server events
Administration
Overview
Audit Logs
List audit logs
Admin API Keys
Create an admin API key
Retrieve an admin API key
Delete an admin API key
List admin API keys
Usage
Audio Speeches
Audio Transcriptions
Code Interpreter Sessions
Completions
Embeddings
Images
Moderations
Vector Stores
File Search Calls
Web Search Calls
Costs
Invites
Create an invite
Retrieve an invite
Delete an invite
List invites
Users
Retrieve an user
Update an user
Delete an user
List users
Roles
Create a role
Retrieve a role
Delete a role
List roles
Groups
Create a group
Retrieve a group
Update a group
Delete a group
List groups
Users
Create an user
Retrieve an user
Delete an user
List users
Roles
Create a role
Retrieve a role
Delete a role
List roles
Roles
Create a role
Retrieve a role
Update a role
Delete a role
List roles
Data Retention
Retrieve a data retention
Update a data retention
Spend Alerts
Create a spend alert
Retrieve a spend alert
Update a spend alert
Delete a spend alert
List spend alerts
Certificates
Create a certificate
Retrieve a certificate
Update a certificate
Delete a certificate
List certificates
Activate
Deactivate
Projects
Create a project
Retrieve a project
Update a project
List projects
Archive
Users
Create an user
Retrieve an user
Update an user
Delete an user
List users
Roles
Create a role
Retrieve a role
Delete a role
List roles
Service Accounts
Create a service account
Retrieve a service account
Update a service account
Delete a service account
List service accounts
API Keys
Retrieve an API key
Delete an API key
List API keys
Rate Limits
Update Rate Limit
List Rate Limits
Model Permissions
Retrieve a model permission
Update a model permission
Delete a model permission
Hosted Tool Permissions
Retrieve a hosted tool permission
Update a hosted tool permission
Groups
Create a group
Retrieve a group
Delete a group
List groups
Roles
Create a role
Retrieve a role
Delete a role
List roles
Roles
Create a role
Retrieve a role
Update a role
Delete a role
List roles
Data Retention
Retrieve a data retention
Update a data retention
Spend Alerts
Create a spend alert
Retrieve a spend alert
Update a spend alert
Delete a spend alert
List spend alerts
Certificates
List certificates
Activate
Deactivate
Chat Completions
Chat Completions
Overview
Create a chat completion
Retrieve a chat completion
Update a chat completion
Delete a chat completion
List chat completions
List chat completions
Streaming events
Legacy
Realtime Beta
Overview
Assistants
Create an assistant
Retrieve an assistant
Update an assistant
Delete an assistant
List assistants
Threads
Create a thread
Create And Run
Retrieve a thread
Update a thread
Delete a thread
Runs
Create a run
Retrieve a run
Update a run
List runs
Cancel a run
Submit Tool Outputs
Steps
Retrieve a step
List steps
Messages
Create a message
Retrieve a message
Update a message
Delete a message
List messages
Assistants streaming events
Completions
Create a completion
API Reference
Realtime
Copy Markdown
Open in
Claude
Open in
ChatGPT
Open in
Cursor
Copy Markdown
View as Markdown
Calls
Accept call
realtime.calls.
accept
(
call_id
,
**kwargs
)
-> void
POST
/realtime/calls/{call_id}/accept
Hang up call
realtime.calls.
hangup
(
call_id
)
-> void
POST
/realtime/calls/{call_id}/hangup
Refer call
realtime.calls.
refer
(
call_id
,
**kwargs
)
-> void
POST
/realtime/calls/{call_id}/refer
Reject call
realtime.calls.
reject
(
call_id
,
**kwargs
)
-> void
POST
/realtime/calls/{call_id}/reject