OpenAI API Reference Documentation (Markdown)

This repository contains OpenAI API documentation converted to Markdown format.

API Reference Chapters

• Overview

Responses

• Create Response
• Retrieve Response
• Cancel Response
• Delete Response
• Compact Response
• List Input Items
• Count Input Tokens

Conversations

• Create Conversation
• Retrieve Conversation
• Update Conversation
• Delete Conversation
• Create Conversation Item
• List Conversation Items
• Retrieve Conversation Item
• Delete Conversation Item

Chat Completions

• Create Completion
• Retrieve Completion
• Update Completion
• Delete Completion
• List Completions
• List Completion Messages

Completions

• Create Completion

Realtime

• Create Session
• Create Client Secret
• Create Transcription Session
• Accept Call
• Hangup Call
• Refer Call
• Reject Call

Audio

• Create Speech
• Create Transcription
• Create Translation
• Create Voice
• Create Voice Consent
• Retrieve Voice Consent
• Update Voice Consent
• Delete Voice Consent
• List Voice Consents

Images

• Generate Image
• Edit Image
• Create Variation

Videos

• Create Video
• Retrieve Video
• List Videos
• Delete Video
• Edit Video
• Extend Video
• Remix Video
• Download Content
• Create Character
• Get Character

Embeddings

• Create Embedding

Models

• List Models
• Retrieve Model
• Delete Model

Moderations

• Create Moderation

Files

• Create File
• Retrieve File
• List Files
• Delete File
• File Content

Uploads

• Create Upload
• Complete Upload
• Cancel Upload
• Create Upload Part

Batches

• Create Batch
• Retrieve Batch
• List Batches
• Cancel Batch

Fine-tuning

• Create Fine-tuning Job
• Retrieve Fine-tuning Job
• List Fine-tuning Jobs
• Cancel Fine-tuning Job
• Pause Fine-tuning Job
• Resume Fine-tuning Job
• List Fine-tuning Events
• List Checkpoints
• Create Checkpoint Permission
• Retrieve Checkpoint Permission
• Delete Checkpoint Permission
• Run Grader (Alpha)
• Validate Grader (Alpha)

Evals

• Create Eval
• Retrieve Eval
• Update Eval
• Delete Eval
• List Evals
• Create Eval Run
• Retrieve Eval Run
• List Eval Runs
• Cancel Eval Run
• Delete Eval Run
• List Output Items
• Retrieve Output Item

Vector Stores

• Create Vector Store
• Retrieve Vector Store
• Update Vector Store
• Delete Vector Store
• List Vector Stores
• Search Vector Store
• Create File
• Retrieve File
• Update File
• Delete File
• List Files
• File Content
• Create File Batch
• Retrieve File Batch
• Cancel File Batch
• List Batch Files

Containers

• Create Container
• Retrieve Container
• List Containers
• Delete Container
• Create Container File
• Retrieve Container File
• List Container Files
• Delete Container File
• Retrieve File Content

Skills

• Create Skill
• Retrieve Skill
• Update Skill
• Delete Skill
• List Skills
• Retrieve Skill Content
• Create Skill Version
• Retrieve Skill Version
• List Skill Versions
• Delete Skill Version
• Retrieve Version Content

Beta (Assistants)

• Create Assistant
• Retrieve Assistant
• Update Assistant
• Delete Assistant
• List Assistants
• Create Thread
• Retrieve Thread
• Update Thread
• Delete Thread
• Create and Run Thread
• Create Message
• Retrieve Message
• Update Message
• Delete Message
• List Messages
• Create Run
• Retrieve Run
• Update Run
• Cancel Run
• List Runs
• Submit Tool Outputs
• Retrieve Run Step
• List Run Steps

Beta (ChatKit)

• Create Session
• Cancel Session
• List Threads
• Retrieve Thread
• Delete Thread
• List Thread Items

Webhooks

• Webhook Events

Organization (Administration)

• Create Admin API Key
• Retrieve Admin API Key
• Delete Admin API Key
• List Admin API Keys
• List Audit Logs
• Get Audit Log Costs
• Create Invite
• Retrieve Invite
• Delete Invite
• List Invites
• List Users
• Retrieve User
• Update User
• Delete User
• Create User Role
• List User Roles
• Delete User Role
• Create Group
• Update Group
• Delete Group
• List Groups
• Add User to Group
• Remove User from Group
• List Group Users
• Create Group Role
• List Group Roles
• Delete Group Role
• Create Role
• Update Role
• Delete Role
• List Roles
• Create Certificate
• Retrieve Certificate
• Update Certificate
• Delete Certificate
• List Certificates
• Activate Certificate
• Deactivate Certificate
• Create Project
• Retrieve Project
• Update Project
• Archive Project
• List Projects
• Add User to Project
• Retrieve Project User
• Update Project User
• Remove Project User
• List Project Users
• Create Project User Role
• List Project User Roles
• Delete Project User Role
• Add Group to Project
• Remove Project Group
• List Project Groups
• Create Project Group Role
• List Project Group Roles
• Delete Project Group Role
• Create Service Account
• Retrieve Service Account
• Delete Service Account
• List Service Accounts
• Retrieve Project API Key
• Delete Project API Key
• List Project API Keys
• Create Project Role
• Update Project Role
• Delete Project Role
• List Project Roles
• List Rate Limits
• Update Rate Limit
• Activate Project Certificate
• Deactivate Project Certificate
• List Project Certificates
• Get Completions Usage
• Get Embeddings Usage
• Get Images Usage
• Get Audio Speeches Usage
• Get Audio Transcriptions Usage
• Get Moderations Usage
• Get Vector Stores Usage
• Get Code Interpreter Sessions Usage