API Reference
Libraries
API Overview
Admin
AdminOrganization
AdminOrganizationAdmin API Keys
Create admin API key
POST/organization/admin_api_keys
Delete admin API key
DELETE/organization/admin_api_keys/{key_id}
List all organization and project API keys.
GET/organization/admin_api_keys
Retrieve admin API key
GET/organization/admin_api_keys/{key_id}
AdminOrganizationAudit Logs
List user actions and configuration changes within this organization.
List audit logs
GET/organization/audit_logs
AdminOrganizationCertificates
Activate certificates for organization
POST/organization/certificates/activate
Upload certificate
POST/organization/certificates
Deactivate certificates for organization
POST/organization/certificates/deactivate
Delete certificate
DELETE/organization/certificates/{certificate_id}
List organization certificates
GET/organization/certificates
Get certificate
GET/organization/certificates/{certificate_id}
Modify certificate
POST/organization/certificates/{certificate_id}
AdminOrganizationData Retention
Retrieve organization data retention
GET/organization/data_retention
Update organization data retention
POST/organization/data_retention
AdminOrganizationGroups
Create group
POST/organization/groups
Delete group
DELETE/organization/groups/{group_id}
List groups
GET/organization/groups
Retrieve group
GET/organization/groups/{group_id}
Update group
POST/organization/groups/{group_id}
AdminOrganizationGroupsRoles
Assign organization role to group
POST/organization/groups/{group_id}/roles
Unassign organization role from group
DELETE/organization/groups/{group_id}/roles/{role_id}
List group organization role assignments
GET/organization/groups/{group_id}/roles
Retrieve group organization role
GET/organization/groups/{group_id}/roles/{role_id}
AdminOrganizationGroupsUsers
Add group user
POST/organization/groups/{group_id}/users
Remove group user
DELETE/organization/groups/{group_id}/users/{user_id}
List group users
GET/organization/groups/{group_id}/users
Retrieve group user
GET/organization/groups/{group_id}/users/{user_id}
AdminOrganizationInvites
Create invite
POST/organization/invites
Delete invite
DELETE/organization/invites/{invite_id}
List invites
GET/organization/invites
Retrieve invite
GET/organization/invites/{invite_id}
AdminOrganizationProjects
Archive project
POST/organization/projects/{project_id}/archive
Create project
POST/organization/projects
List projects
GET/organization/projects
Retrieve project
GET/organization/projects/{project_id}
Modify project
POST/organization/projects/{project_id}
AdminOrganizationProjectsAPI Keys
Delete project API key
DELETE/organization/projects/{project_id}/api_keys/{api_key_id}
List project API keys
GET/organization/projects/{project_id}/api_keys
Retrieve project API key
GET/organization/projects/{project_id}/api_keys/{api_key_id}
AdminOrganizationProjectsCertificates
Activate certificates for project
POST/organization/projects/{project_id}/certificates/activate
Deactivate certificates for project
POST/organization/projects/{project_id}/certificates/deactivate
List project certificates
GET/organization/projects/{project_id}/certificates
AdminOrganizationProjectsData Retention
Retrieve project data retention
GET/organization/projects/{project_id}/data_retention
Update project data retention
POST/organization/projects/{project_id}/data_retention
AdminOrganizationProjectsGroups
Add project group
POST/organization/projects/{project_id}/groups
Remove project group
DELETE/organization/projects/{project_id}/groups/{group_id}
List project groups
GET/organization/projects/{project_id}/groups
Retrieve project group
GET/organization/projects/{project_id}/groups/{group_id}
AdminOrganizationProjectsGroupsRoles
Assign project role to group
POST/projects/{project_id}/groups/{group_id}/roles
Unassign project role from group
DELETE/projects/{project_id}/groups/{group_id}/roles/{role_id}
List project group role assignments
GET/projects/{project_id}/groups/{group_id}/roles
Retrieve project group role
GET/projects/{project_id}/groups/{group_id}/roles/{role_id}
AdminOrganizationProjectsHosted Tool Permissions
Retrieve project hosted tool permissions
GET/organization/projects/{project_id}/hosted_tool_permissions
Modify project hosted tool permissions
POST/organization/projects/{project_id}/hosted_tool_permissions
AdminOrganizationProjectsModel Permissions
Delete project model permissions
DELETE/organization/projects/{project_id}/model_permissions
Retrieve project model permissions
GET/organization/projects/{project_id}/model_permissions
Modify project model permissions
POST/organization/projects/{project_id}/model_permissions
AdminOrganizationProjectsRate Limits
List project rate limits
GET/organization/projects/{project_id}/rate_limits
Modify project rate limit
POST/organization/projects/{project_id}/rate_limits/{rate_limit_id}
AdminOrganizationProjectsRoles
Create project role
POST/projects/{project_id}/roles
Delete project role
DELETE/projects/{project_id}/roles/{role_id}
List project roles
GET/projects/{project_id}/roles
Retrieve project role
GET/projects/{project_id}/roles/{role_id}
Update project role
POST/projects/{project_id}/roles/{role_id}
AdminOrganizationProjectsService Accounts
Create project service account
POST/organization/projects/{project_id}/service_accounts
Delete project service account
DELETE/organization/projects/{project_id}/service_accounts/{service_account_id}
List project service accounts
GET/organization/projects/{project_id}/service_accounts
Retrieve project service account
GET/organization/projects/{project_id}/service_accounts/{service_account_id}
Update project service account
POST/organization/projects/{project_id}/service_accounts/{service_account_id}
AdminOrganizationProjectsService AccountsAPI Keys
Create project service account API key
POST/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys
AdminOrganizationProjectsSpend Alerts
Create project spend alert
POST/organization/projects/{project_id}/spend_alerts
Delete project spend alert
DELETE/organization/projects/{project_id}/spend_alerts/{alert_id}
List project spend alerts
GET/organization/projects/{project_id}/spend_alerts
Retrieve project spend alert
GET/organization/projects/{project_id}/spend_alerts/{alert_id}
Update project spend alert
POST/organization/projects/{project_id}/spend_alerts/{alert_id}
AdminOrganizationProjectsSpend Limit
Delete project spend limit
DELETE/organization/projects/{project_id}/spend_limit
Retrieve project spend limit
GET/organization/projects/{project_id}/spend_limit
Update project spend limit
POST/organization/projects/{project_id}/spend_limit
AdminOrganizationProjectsUsers
Create project user
POST/organization/projects/{project_id}/users
Delete project user
DELETE/organization/projects/{project_id}/users/{user_id}
List project users
GET/organization/projects/{project_id}/users
Retrieve project user
GET/organization/projects/{project_id}/users/{user_id}
Modify project user
POST/organization/projects/{project_id}/users/{user_id}
AdminOrganizationProjectsUsersRoles
Assign project role to user
POST/projects/{project_id}/users/{user_id}/roles
Unassign project role from user
DELETE/projects/{project_id}/users/{user_id}/roles/{role_id}
List project user role assignments
GET/projects/{project_id}/users/{user_id}/roles
Retrieve project user role
GET/projects/{project_id}/users/{user_id}/roles/{role_id}
AdminOrganizationRoles
Create organization role
POST/organization/roles
Delete organization role
DELETE/organization/roles/{role_id}
List organization roles
GET/organization/roles
Retrieve organization role
GET/organization/roles/{role_id}
Update organization role
POST/organization/roles/{role_id}
AdminOrganizationSpend Alerts
Create organization spend alert
POST/organization/spend_alerts
Delete organization spend alert
DELETE/organization/spend_alerts/{alert_id}
List organization spend alerts
GET/organization/spend_alerts
Retrieve organization spend alert
GET/organization/spend_alerts/{alert_id}
Update organization spend alert
POST/organization/spend_alerts/{alert_id}
AdminOrganizationSpend Limit
Delete organization spend limit
DELETE/organization/spend_limit
Retrieve organization spend limit
GET/organization/spend_limit
Update organization spend limit
POST/organization/spend_limit
AdminOrganizationUsage
Audio speeches
GET/organization/usage/audio_speeches
Audio transcriptions
GET/organization/usage/audio_transcriptions
Code interpreter sessions
GET/organization/usage/code_interpreter_sessions
Completions
GET/organization/usage/completions
Costs
GET/organization/costs
Embeddings
GET/organization/usage/embeddings
File search calls
GET/organization/usage/file_search_calls
Images
GET/organization/usage/images
Moderations
GET/organization/usage/moderations
Vector stores
GET/organization/usage/vector_stores
Web search calls
GET/organization/usage/web_search_calls
AdminOrganizationUsers
Delete user
DELETE/organization/users/{user_id}
List users
GET/organization/users
Retrieve user
GET/organization/users/{user_id}
Modify user
POST/organization/users/{user_id}
AdminOrganizationUsersRoles
Assign organization role to user
POST/organization/users/{user_id}/roles
Unassign organization role from user
DELETE/organization/users/{user_id}/roles/{role_id}
List user organization role assignments
GET/organization/users/{user_id}/roles
Retrieve user organization role
GET/organization/users/{user_id}/roles/{role_id}
Audio
AudioSpeech
Turn audio into text or text into audio.
Create speech
POST/audio/speech
AudioTranscriptions
Turn audio into text or text into audio.
Create transcription
POST/audio/transcriptions
AudioTranslations
Turn audio into text or text into audio.
Create translation
POST/audio/translations
AudioVoice Consents
Turn audio into text or text into audio.
Create voice consent
POST/audio/voice_consents
Delete voice consent
DELETE/audio/voice_consents/{consent_id}
List voice consents
GET/audio/voice_consents
Retrieve voice consent
GET/audio/voice_consents/{consent_id}
Update voice consent
POST/audio/voice_consents/{consent_id}
AudioVoices
Turn audio into text or text into audio.
Create voice
POST/audio/voices
Batches
Create large batches of API requests to run asynchronously.
Cancel batch
POST/batches/{batch_id}/cancel
Create batch
POST/batches
List batches
GET/batches
Retrieve batch
GET/batches/{batch_id}
Beta
BetaAssistants
Build Assistants that can call models and use tools.
BetaChatKit
BetaChatKitSessions
Cancel chat session
POST/chatkit/sessions/{session_id}/cancel
Create ChatKit session
POST/chatkit/sessions
BetaChatKitThreads
Delete ChatKit thread
DELETE/chatkit/threads/{thread_id}
List ChatKit threads
GET/chatkit/threads
List ChatKit thread items
GET/chatkit/threads/{thread_id}/items
Retrieve ChatKit thread
GET/chatkit/threads/{thread_id}
BetaResponses
Cancel a response
POST/responses/{response_id}/cancel
Compact a response
POST/responses/compact
Create a model response
POST/responses
Delete a model response
DELETE/responses/{response_id}
Get a model response
GET/responses/{response_id}
BetaResponsesInput Items
List input items
GET/responses/{response_id}/input_items
BetaResponsesInput Tokens
Get input token counts
POST/responses/input_tokens
BetaThreads
Build Assistants that can call models and use tools.
BetaThreadsMessages
Build Assistants that can call models and use tools.
BetaThreadsRuns
Build Assistants that can call models and use tools.
BetaThreadsRunsSteps
Build Assistants that can call models and use tools.
Chat
ChatCompletions
Given a list of messages comprising a conversation, the model will return a response.
Create chat completion
POST/chat/completions
Delete chat completion
DELETE/chat/completions/{completion_id}
List Chat Completions
GET/chat/completions
Get chat completion
GET/chat/completions/{completion_id}
Update chat completion
POST/chat/completions/{completion_id}
ChatCompletionsMessages
Given a list of messages comprising a conversation, the model will return a response.
Get chat messages
GET/chat/completions/{completion_id}/messages
Completions
Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.
Create completion
POST/completions
Containers
Create container
POST/containers
Delete a container
DELETE/containers/{container_id}
List containers
GET/containers
Retrieve container
GET/containers/{container_id}
ContainersFiles
Create container file
POST/containers/{container_id}/files
Delete a container file
DELETE/containers/{container_id}/files/{file_id}
List container files
GET/containers/{container_id}/files
Retrieve container file
GET/containers/{container_id}/files/{file_id}
ContainersFilesContent
Retrieve container file content
GET/containers/{container_id}/files/{file_id}/content
Content Provenance Checks
Create content provenance check
POST/content_provenance_checks
Conversations
Manage conversations and conversation items.
Create a conversation
POST/conversations
Delete a conversation
DELETE/conversations/{conversation_id}
Retrieve a conversation
GET/conversations/{conversation_id}
Update a conversation
POST/conversations/{conversation_id}
ConversationsItems
Manage conversations and conversation items.
Create items
POST/conversations/{conversation_id}/items
Delete an item
DELETE/conversations/{conversation_id}/items/{item_id}
List items
GET/conversations/{conversation_id}/items
Retrieve an item
GET/conversations/{conversation_id}/items/{item_id}
Embeddings
Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
Create embeddings
POST/embeddings
Evals
Manage and run evals in the OpenAI platform.
Create eval
POST/evals
Delete an eval
DELETE/evals/{eval_id}
List evals
GET/evals
Get an eval
GET/evals/{eval_id}
Update an eval
POST/evals/{eval_id}
EvalsRuns
Manage and run evals in the OpenAI platform.
Cancel eval run
POST/evals/{eval_id}/runs/{run_id}
Create eval run
POST/evals/{eval_id}/runs
Delete eval run
DELETE/evals/{eval_id}/runs/{run_id}
Get eval runs
GET/evals/{eval_id}/runs
Get an eval run
GET/evals/{eval_id}/runs/{run_id}
EvalsRunsOutput Items
Manage and run evals in the OpenAI platform.
Get eval run output items
GET/evals/{eval_id}/runs/{run_id}/output_items
Get an output item of an eval run
GET/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
Files
Files are used to upload documents that can be used with features like Assistants and Fine-tuning.
Retrieve file content
GET/files/{file_id}/content
Upload file
POST/files
Delete file
DELETE/files/{file_id}
List files
GET/files
Retrieve file
GET/files/{file_id}
Fine Tuning
Fine TuningAlpha
Fine TuningAlphaGraders
Manage fine-tuning jobs to tailor a model to your specific training data.
Run grader
POST/fine_tuning/alpha/graders/run
Validate grader
POST/fine_tuning/alpha/graders/validate
Fine TuningCheckpoints
Fine TuningCheckpointsPermissions
Manage fine-tuning jobs to tailor a model to your specific training data.
Create checkpoint permissions
POST/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
Delete checkpoint permission
DELETE/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}
List checkpoint permissions
GET/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
List checkpoint permissions
Deprecated
GET/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
Fine TuningJobs
Manage fine-tuning jobs to tailor a model to your specific training data.
Cancel fine-tuning
POST/fine_tuning/jobs/{fine_tuning_job_id}/cancel
Create fine-tuning job
POST/fine_tuning/jobs
List fine-tuning jobs
GET/fine_tuning/jobs
List fine-tuning events
GET/fine_tuning/jobs/{fine_tuning_job_id}/events
Pause fine-tuning
POST/fine_tuning/jobs/{fine_tuning_job_id}/pause
Resume fine-tuning
POST/fine_tuning/jobs/{fine_tuning_job_id}/resume
Retrieve fine-tuning job
GET/fine_tuning/jobs/{fine_tuning_job_id}
Fine TuningJobsCheckpoints
Manage fine-tuning jobs to tailor a model to your specific training data.
List fine-tuning checkpoints
GET/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
Fine TuningMethods
Graders
GradersGrader Models
Images
Given a prompt and/or an input image, the model will generate a new image.
Create image variation
POST/images/variations
Create image edit
POST/images/edits
Create image
POST/images/generations
Models
List and describe the various models available in the API.
Moderations
Given text and/or image inputs, classifies if those inputs are potentially harmful.
Create moderation
POST/moderations
Realtime
RealtimeCalls
Accept call
POST/realtime/calls/{call_id}/accept
Hang up call
POST/realtime/calls/{call_id}/hangup
Refer call
POST/realtime/calls/{call_id}/refer
Reject call
POST/realtime/calls/{call_id}/reject
RealtimeClient Secrets
Create client secret
POST/realtime/client_secrets
RealtimeSessions
RealtimeTranscription Sessions
RealtimeTranslations
RealtimeTranslationsClient Secrets
Create translation client secret
POST/realtime/translations/client_secrets
Responses
Cancel a response
POST/responses/{response_id}/cancel
Compact a response
POST/responses/compact
Create a model response
POST/responses
Delete a model response
DELETE/responses/{response_id}
Get a model response
GET/responses/{response_id}
ResponsesInput Items
List input items
GET/responses/{response_id}/input_items
ResponsesInput Tokens
Get input token counts
POST/responses/input_tokens
Skills
Create a new skill.
POST/skills
Delete a skill by its ID.
DELETE/skills/{skill_id}
List all skills for the current project.
GET/skills
Get a skill by its ID.
GET/skills/{skill_id}
Update the default version pointer for a skill.
POST/skills/{skill_id}
SkillsContent
Download a skill zip bundle by its ID.
GET/skills/{skill_id}/content
SkillsVersions
Create a new immutable skill version.
POST/skills/{skill_id}/versions
Delete a skill version.
DELETE/skills/{skill_id}/versions/{version}
List skill versions for a skill.
GET/skills/{skill_id}/versions
Get a specific skill version.
GET/skills/{skill_id}/versions/{version}
SkillsVersionsContent
Download a skill version zip bundle.
GET/skills/{skill_id}/versions/{version}/content
Uploads
Use Uploads to upload large files in multiple parts.
Cancel upload
POST/uploads/{upload_id}/cancel
Complete upload
POST/uploads/{upload_id}/complete
Create upload
POST/uploads
UploadsParts
Use Uploads to upload large files in multiple parts.
Add upload part
POST/uploads/{upload_id}/parts
Vector Stores
Create vector store
POST/vector_stores
Delete vector store
DELETE/vector_stores/{vector_store_id}
List vector stores
GET/vector_stores
Retrieve vector store
GET/vector_stores/{vector_store_id}
Search vector store
POST/vector_stores/{vector_store_id}/search
Modify vector store
POST/vector_stores/{vector_store_id}
Vector StoresFile Batches
Cancel vector store file batch
POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
Create vector store file batch
POST/vector_stores/{vector_store_id}/file_batches
List vector store files in a batch
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files
Retrieve vector store file batch
GET/vector_stores/{vector_store_id}/file_batches/{batch_id}
Vector StoresFiles
Retrieve vector store file content
GET/vector_stores/{vector_store_id}/files/{file_id}/content
Create vector store file
POST/vector_stores/{vector_store_id}/files
Delete vector store file
DELETE/vector_stores/{vector_store_id}/files/{file_id}
List vector store files
GET/vector_stores/{vector_store_id}/files
Retrieve vector store file
GET/vector_stores/{vector_store_id}/files/{file_id}
Update vector store file attributes
POST/vector_stores/{vector_store_id}/files/{file_id}
Videos
Create a new video generation job by editing a source video or existing generated video.
Deprecated
POST/videos/edits
Webhooks
Unwrap
Function