Skip to content
Home
API
Docs
Guides and concepts for the OpenAI API
API reference
Endpoints, parameters, and responses
Codex
ChatGPT
Apps SDK
Build apps to extend ChatGPT
Commerce
Build commerce flows in ChatGPT
Learn
Resources
Assets for developers building with OpenAI
Cookbook
Notebook examples for building with OpenAI models
Blog
Learnings and experiences from developers
API Dashboard
Search the API docs
Close
Primary navigation
Home
API
Codex
ChatGPT
Learn
Docs
API reference
Getting Started
Overview
Quickstart
Explore
Pricing
Ambassadors
Concepts
Prompting
Workflows
Models
Using Codex
App
Overview
Features
Settings
Review
Automations
Worktrees
Local Environments
Commands
Troubleshooting
IDE Extension
Overview
Features
Settings
IDE Commands
Slash commands
CLI
Overview
Features
Command Line Options
Slash commands
Web
Overview
Environments
Internet Access
Integrations
GitHub
Slack
Linear
Configuration
Config File
Config Basics
Advanced Config
Config Reference
Sample Config
Rules
AGENTS.md
MCP
Skills
Administration
Authentication
Security
Enterprise
Admin Setup
Governance
Windows
Automation
Non-interactive Mode
Codex SDK
App Server
MCP Server
GitHub Action
Learn
Videos
Blog
Testing Agent Skills Systematically with Evals
Supercharging Codex with JetBrains MCP at Skyscanner
View all
Cookbooks
Codex Prompting Guide
Modernizing your Codebase with Codex
View all
Building AI Teams
Releases
Changelog
Feature Maturity
Open Source
Apps SDK
Commerce
Home
Changelog
Docs MCP
Categories
Code
Cookbooks
Guides
Videos
Topics
Agents
Audio & Voice
Computer use
Codex
Evals
gpt-oss
Fine-tuning
Image generation
Scaling
Tools
Video generation
API Dashboard
HTTP
HTTP
HTTP
TypeScript
TypeScript
Python
Python
Java
Java
Go
Go
Ruby
Ruby
API Reference
API Reference
Introduction
Authentication
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
Webhooks
Events
Unwrap
Platform APIs
Audio
Create a transcription
Create a translation
Create a speech
Create a voice
Voice Consents
Create a voice consent
Retrieve a voice consent
Update a voice consent
Delete a voice consent
List voice consents
Videos
Create a video
Retrieve a video
Delete a video
List videos
Download Content
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
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
Realtime
Calls
Accept
Hangup
Refer
Reject
Client Secrets
Create a client secret
Client events
Server events
Administration
Overview
Organization
Audit Logs
Get Costs
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
Get Audio Speeches
Get Audio Transcriptions
Get Code Interpreter Sessions
Get Completions
Get Embeddings
Get Images
Get Moderations
Get Vector Stores
Invites
Create an invite
Retrieve an invite
Delete an invite
List invites
Users
Retrieve an user
Update an user
Delete an user
List users
User roles
Create an user role
Delete an user role
List user roles
Groups
Create a group
Update a group
Delete a group
List groups
Users
Create an user
Delete an user
List users
Group roles
Create a group role
Delete a group role
List group roles
Roles
Create a role
Update a role
Delete a role
List roles
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
Service Accounts
Create a service account
Retrieve 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
Get Rate Limits
Update Rate Limit
Groups
Create a group
Delete a group
List groups
Certificates
List certificates
Activate
Deactivate
Projects
Roles
Create a role
Update a role
Delete a role
List roles
Group roles
Create a group role
Delete a group role
List group roles
User roles
Create an user role
Delete an user role
List user roles
Chat Completions
Chat Completions
Overview
Create a completion
Retrieve a completion
Update a completion
Delete a completion
List completions
List messages
Streaming events
Legacy
Realtime Beta
Overview
Sessions
Create a session
Transcription Sessions
Create a transcription session
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
Create an assistant
Retrieve an assistant
Update an assistant
Delete an assistant
List assistants
Assistants streaming events
Completions
Create a completion
API Reference
Webhooks
Copy Markdown
Open in
Claude
Open in
ChatGPT
Open in
Cursor
Copy Markdown
View as Markdown
Unwrap
Function
Validates that the given payload was sent by OpenAI and parses the payload.
Supported Languages
This method is available in:
Returns Examples