Skip to content

Guides and concepts for the OpenAI API

Endpoints, parameters, and responses

Guides, concepts, and product docs for Codex

Example workflows and tasks teams hand to Codex

Build apps to extend ChatGPT

Workspace Agents

Trigger published ChatGPT workspace agents

Build commerce flows in ChatGPT

Publish and measure ads in ChatGPT

Demo apps to get inspired

Learnings and experiences from developers

Notebook examples for building with OpenAI models

Docs, videos, and demo apps for building with OpenAI

Programs, meetups, and support for builders

Search the API docs

Search docs

Suggested

Primary navigation

Search docs

Suggested

Get started

Overview
Quickstart
Models
Pricing
SDKs and CLI
Latest: GPT-5.5
Prompt guidance

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

Tools

Web search
MCP and Connectors
- Secure MCP Tunnel
Skills
Shell
Computer use
File search and retrieval
- File search
- Retrieval
Tool search
More tools

Run and scale

Conversation state
Background mode
Streaming
WebSocket mode
Webhooks
File inputs
Context management
Prompting
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
Realtime sessions

Specialized models

Image generation
Video generation
Deep research
Embeddings
Moderation

Going live

Production best practices
Workload identity federation
Deployment checklist
Amazon Bedrock
Latency optimization
Cost optimization
Accuracy optimization
Safety

Legacy APIs

Agent Builder
Evals
Fine-tuning
Assistants API

Resources

Terms and policies
Changelog
Your data
Permissions
Rate limits
IP egress ranges
Admin APIs
Deprecations
MCP for deep research
Developer mode
ChatGPT Actions

Getting Started

Overview
Quickstart
Explore use cases
Import to Codex
Pricing
Concepts

Using Codex

App
IDE Extension
CLI
Web
Integrations
Codex Security
- Overview
- Codex Security plugin
- Codex Security cloud
  - Setup
  - Improving the threat model
- FAQ

Configuration

Config File
Permissions
Speed
Rules
Hooks
AGENTS.md
MCP
Plugins
- Overview
- Build plugins
Sites
Skills
Subagents

Administration

Authentication
- Overview
- Access tokens
Agent approvals & security
Remote connections
Deployment
- Amazon Bedrock
Enterprise
Windows

Automation

Non-interactive Mode
Codex SDK
App Server
MCP Server
GitHub Action

Learn

Best practices
Videos
Community
Blog
Cookbooks
Building AI Teams

Releases

Changelog
Feature Maturity
Open Source

Home
Collections

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
Conversions API
Supported events

Advertiser API

Overview
Quickstart
Product feeds
Campaign Targeting

API Reference

Authentication
Campaigns
Ad Groups
Ads
Ad Account
Insights
Files

Home
API examples
Sites

All posts

Recent

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
Using skills to accelerate OSS maintenance
Building frontend UIs with Codex and Figma

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

Events

Meetups
Hackathon Support

Forum
Discord

API API Reference Codex ChatGPT Resources

API Reference
API Reference
Responses API
Webhooks
- Events
Platform APIs
- Audio
- Videos
- Images
- Embeddings
  - Create an embedding
- 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
- Files
- Uploads
- Models
- Moderations
  - Create a moderation
Vector Stores
- Vector Stores
- Files
- File Batches
ChatKit
- Sessions
  - Create a session
  - Cancel a session
- Threads
Containers
- Containers
- Files
Skills
- Skills
Realtime
- Translations
  - Translation client events
  - Translation server events
- Client Secrets
  - Create a client secret
- Calls
- Client events
- Server events
Administration
- Overview
- Audit Logs
  - List audit logs
- Admin API Keys
- Usage
- Invites
- Users
- Groups
- Roles
- Data Retention
  - Retrieve a data retention
  - Update a data retention
- Spend Alerts
- Certificates
- 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
Legacy
- Realtime Beta
  - Overview
- Assistants
- Completions
  - Create a completion

Content

Retrieve container file content

$ openai containers:files:content retrieve

GET/containers/{container_id}/files/{file_id}/content