Markdown mirror of OpenAI's documentation.
Contains 516 pages, discovered from the page index and supplementary index.
Links to mirrored pages point to local files; external links and images remain online. Code examples and OpenAPI blocks are preserved.
Generated files are replaced by the next successful sync. Original content belongs to OpenAI and its respective authors; this mirror grants no additional rights.
- Admin
- Create admin API key
- Delete admin API key
- Admin API Keys
- List all organization and project API keys.
- Retrieve admin API key
- Audit Logs
- List audit logs
- Activate certificates for organization
- Upload certificate
- Deactivate certificates for organization
- Delete certificate
- Certificates
- List organization certificates
- Get certificate
- Modify certificate
- Data Retention
- Retrieve organization data retention
- Update organization data retention
- Add an external key config for an organization
- Delete an external key config for the user's organization
- External Keys
- List the external key configs registered on the user's organization
- Retrieve an external key registration
- Validate an external key config for the user's organization
- Create an external storage configuration
- Delete an external storage configuration
- External Storage
- List external storage configurations
- Get an external storage configuration
- Validate an external storage configuration
- Create group
- Delete group
- Groups
- List groups
- Retrieve group
- Assign organization role to group
- Unassign organization role from group
- Roles
- List group organization role assignments
- Retrieve group organization role
- Update group
- Add group user
- Remove group user
- Users
- List group users
- Retrieve group user
- Organization
- Create invite
- Delete invite
- Invites
- List invites
- Retrieve invite
- Delete project API key
- API Keys
- List project API keys
- Retrieve project API key
- Update project API key
- Archive project
- Activate certificates for project
- Deactivate certificates for project
- Certificates
- List project certificates
- Create project
- Data Retention
- Retrieve project data retention
- Update project data retention
- Add project group
- Remove project group
- Groups
- List project groups
- Retrieve project group
- Assign project role to group
- Unassign project role from group
- Roles
- List project group role assignments
- Retrieve project group role
- Hosted Tool Permissions
- Retrieve project hosted tool permissions
- Modify project hosted tool permissions
- Projects
- List projects
- Delete project model permissions
- Model Permissions
- Retrieve project model permissions
- Modify project model permissions
- Rate Limits
- List project rate limits
- Modify project rate limit
- Retrieve project
- Create project role
- Delete project role
- Roles
- List project roles
- Retrieve project role
- Update project role
- Create an API key for a service account
- API Keys
- Create project service account
- Delete project service account
- Service Accounts
- List project service accounts
- Retrieve project service account
- Update project service account
- Service Tier Settings
- Retrieve project service tier settings
- Update project service tier settings
- Create project spend alert
- Delete project spend alert
- Spend Alerts
- List project spend alerts
- Retrieve project spend alert
- Update project spend alert
- Delete project spend limit
- Spend Limit
- Get project spend limit
- Update project spend limit
- Modify project
- Create project user
- Delete project user
- Users
- List project users
- Retrieve project user
- Assign project role to user
- Unassign project role from user
- Roles
- List project user role assignments
- Retrieve project user role
- Modify project user
- Create organization role
- Delete organization role
- Roles
- List organization roles
- Retrieve organization role
- Update organization role
- Create organization spend alert
- Delete organization spend alert
- Spend Alerts
- List organization spend alerts
- Retrieve organization spend alert
- Update organization spend alert
- Delete organization spend limit
- Spend Limit
- Get organization spend limit
- Update organization spend limit
- Audio speeches
- Audio transcriptions
- Code interpreter sessions
- Completions
- Costs
- Decisions
- Embeddings
- File search calls
- Images
- Usage
- Moderations
- Vector stores
- Web search calls
- Delete user
- Users
- List users
- Retrieve user
- Assign organization role to user
- Unassign organization role from user
- Roles
- List user organization role assignments
- Retrieve user organization role
- Modify user
- Create Platform workload identity provider
- Delete Platform workload identity provider
- Create Platform workload identity federation rule
- Delete Platform workload identity federation rule
- Federation Rules
- List Platform workload identity federation rules
- Retrieve Platform workload identity federation rule
- Update Platform workload identity federation rule
- Workload Identity Providers
- List Platform workload identity providers
- Retrieve Platform workload identity provider
- Update Platform workload identity provider
- Administration Overview
- Audio
- Create speech
- Speech
- Create transcription
- Transcriptions
- Transcription streaming events
- Create translation
- Translations
- Create voice consent
- Delete voice consent
- Voice Consents
- List voice consents
- Retrieve voice consent
- Update voice consent
- Create voice
- Delete voice
- Voices
- Cancel batch
- Create batch
- Batches
- List batches
- Retrieve batch
- Create an automation
- Delete an automation
- Automations
- Invoke an automation
- Invocations
- List automation invocations
- Get an automation invocation
- List automations
- Pause an automation
- Resume an automation
- Get an automation
- Update an automation
- Create an agent
- Delete an agent
- Create an agent environment
- Write an agent environment file
- Files
- List agent environment files
- Environments
- List agent environments
- Retrieve an agent environment
- Create an agent environment template
- Delete an agent environment template
- Templates
- List agent environment templates
- Retrieve an agent environment template
- Update an agent environment template
- Agents
- List agents
- Retrieve an agent
- Retrieve agent session artifact content
- Delete an agent session artifact
- Artifacts
- List agent session artifacts
- Retrieve an agent session artifact
- Create an agent session
- Delete an agent session
- Create agent session input events
- Events
- Stream agent session events
- Sessions
- Items
- List agent session items
- List agent sessions
- Retrieve an agent session
- Subagents
- Items
- List subagent items
- List session subagents
- Retrieve a session subagent
- Turns
- Items
- List subagent turn items
- List subagent turns
- Retrieve a subagent turn
- Traces
- List agent session traces
- Turns
- Items
- List agent session turn items
- List agent session turns
- Retrieve an agent session turn
- Update an agent session
- Agents streaming events
- Update an agent
- Create a vault
- Create a vault credential
- Delete a vault credential
- Credentials
- List vault credentials
- Retrieve a vault credential
- Update a vault credential
- Delete a vault
- Vaults
- List vaults
- Retrieve a vault
- Update a vault
- ChatKit
- Cancel a ChatKit session
- Create a ChatKit session
- Sessions
- Delete a ChatKit thread
- Threads
- List ChatKit threads
- List ChatKit thread items
- Retrieve a ChatKit thread
- Beta
- Cancel a response
- Compact conversation
- Connect
- Create a model response
- Delete a model response
- Responses
- Input Items
- List input items
- Get input token counts
- Input Tokens
- Get a model response
- Beta Responses streaming events
- WebSocket events
- Chat Completions Overview
- Create chat completion
- Delete chat completion
- Completions
- List Chat Completions
- Messages
- Get chat messages
- Get chat completion
- Chat Completions streaming events
- Update chat completion
- Chat
- Create completion
- Completions
- Create container
- Delete a container
- Content
- Retrieve container file content
- Create container file
- Delete a container file
- Files
- List container files
- Retrieve container file
- Containers
- List containers
- Retrieve container
- Create content provenance check
- Content Provenance Checks
- Create a conversation
- Delete a conversation
- Conversations
- Create items
- Delete an item
- Items
- List items
- Retrieve an item
- Retrieve a conversation
- Update a conversation
- Create a decision
- Decisions
- Create embeddings
- Embeddings
- Create eval
- Delete an eval
- Evals
- List evals
- Get an eval
- Cancel eval run
- Create eval run
- Delete eval run
- Runs
- Get eval runs
- Output Items
- Get eval run output items
- Get an output item of an eval run
- Get an eval run
- Update an eval
- Retrieve file content
- Upload file
- Delete file
- Files
- List files
- Retrieve file
- Retrieve content
- Graders
- Run grader
- Validate grader
- Alpha
- Checkpoints
- Create checkpoint permissions
- Delete checkpoint permission
- Permissions
- List checkpoint permissions
- List checkpoint permissions
- Fine Tuning
- Cancel fine-tuning
- Checkpoints
- List fine-tuning checkpoints
- Create fine-tuning job
- Jobs
- List fine-tuning jobs
- List fine-tuning events
- Pause fine-tuning
- Resume fine-tuning
- Retrieve fine-tuning job
- Methods
- Grader Models
- Graders
- Create image variation
- Image edit streaming events
- Create image edit
- Create image
- Image generation streaming events
- Images
- Connect
- Create session
- Fork WebSocket
- Connect
- Forks
- Live
- Primary WebSocket
- Accept call
- Download recording
- Fork session
- Hang up session
- Sessions
- Transfer call
- Reject call
- Sideband WebSocket
- Connect
- Sideband
- Delete a fine-tuned model
- Models
- List models
- Retrieve model
- Create moderation
- Moderations
- API Overview
- Realtime Beta Overview
- Accept call
- Create call
- Hang up call
- Calls
- Refer call
- Reject call
- Realtime client events
- Create client secret
- Client Secrets
- Connect
- Realtime
- Realtime server events
- Create session
- Sessions
- Create transcription session
- Transcription Sessions
- Realtime translation client events
- Realtime translation server events
- Create translation client secret
- Client Secrets
- Connect
- Translations
- Cancel a response
- Compact conversation
- Connect
- Create a model response
- Delete a model response
- Responses
- Input Items
- List input items
- Get input token counts
- Input Tokens
- Responses Overview
- Get a model response
- Responses streaming events
- WebSocket events
- Alerts
- Get project safety alert
- Cases
- Get safety case
- Safety
- Shared
- Content
- Get Skill Content
- Create Skill
- Delete Skill
- Skills
- List Skills
- Get Skill
- Update Skill Default Version
- Content
- Get Skill Version Content
- Create Skill Version
- Delete Skill Version
- Versions
- List Skill Versions
- Get Skill Version
- Cancel upload
- Complete upload
- Create upload
- Uploads
- Add upload part
- Parts
- Create vector store
- Delete vector store
- Cancel vector store file batch
- Create vector store file batch
- File Batches
- List vector store files in a batch
- Retrieve vector store file batch
- Retrieve vector store file content
- Create vector store file
- Delete vector store file
- Files
- List vector store files
- Retrieve vector store file
- Update vector store file attributes
- Vector Stores
- List vector stores
- Retrieve vector store
- Search vector store
- Modify vector store
- Create Webhook Endpoint
- Delete Webhook Endpoint
- Event Types
- List Webhook Event Types
- Webhooks
- List Webhook Endpoints
- Retrieve Webhook Endpoint
- Rotate Webhook Endpoint Signing Secret
- Test Webhook Endpoint
- Unwrap
- Update Webhook Endpoint
- Workload identity token exchange
- Assistants migration guide