Sample - OpenAI API
01
Agents
33 endpoints
- GET/agentsList agents
- GET/agents/{agent_id}Retrieve an agent
- GET/agents/environments/{environment_id}Retrieve an agent environment
- GET/agents/environments/{environment_id}/filesList agent environment files
- GET/agents/environments/templatesList agent environment templates
- GET/agents/environments/templates/{environment_template_id}Retrieve an agent environment template
- GET/agents/sessionsList agent sessions
- GET/agents/sessions/{session_id}Retrieve an agent session
- GET/agents/sessions/{session_id}/artifactsList agent session artifacts
- GET/agents/sessions/{session_id}/artifacts/{artifact_id}Retrieve an agent session artifact
- GET/agents/sessions/{session_id}/artifacts/{artifact_id}/contentRetrieve agent session artifact content
- GET/agents/sessions/{session_id}/eventsStream agent session events
- GET/agents/sessions/{session_id}/itemsList agent session items
- GET/agents/sessions/{session_id}/subagentsList session subagents
- GET/agents/sessions/{session_id}/subagents/{subagent_id}Retrieve a session subagent
- GET/agents/sessions/{session_id}/subagents/{subagent_id}/itemsList subagent items
- GET/agents/sessions/{session_id}/subagents/{subagent_id}/turnsList subagent turns
- GET/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}Retrieve a subagent turn
- GET/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/itemsList subagent turn items
- GET/agents/sessions/{session_id}/turnsList agent session turns
- GET/agents/sessions/{session_id}/turns/{turn_id}Retrieve an agent session turn
- POST/agentsCreate an agent
- POST/agents/{agent_id}Update an agent
- POST/agents/environments/{environment_id}/filesCreate an agent environment file
- POST/agents/environments/templatesCreate an agent environment template
- POST/agents/environments/templates/{environment_template_id}Update an agent environment template
- POST/agents/sessionsCreate an agent session
- POST/agents/sessions/{session_id}Update an agent session
- POST/agents/sessions/{session_id}/eventsCreate agent session input events
- DELETE/agents/{agent_id}Delete an agent
- DELETE/agents/environments/templates/{environment_template_id}Delete an agent environment template
- DELETE/agents/sessions/{session_id}Delete an agent session
- DELETE/agents/sessions/{session_id}/artifacts/{artifact_id}Delete an agent session artifact
02
Assistants
5 endpoints
03
Audio
9 endpoints
- GET/audio/voice_consentsList voice consent recordings
- GET/audio/voice_consents/{consent_id}Retrieve a voice consent recording
- POST/audio/speechCreate speech audio
- POST/audio/transcriptionsCreate an audio transcription
- POST/audio/translationsCreate an audio translation
- POST/audio/voice_consentsCreate a voice consent recording
- POST/audio/voice_consents/{consent_id}Update voice consent metadata
- POST/audio/voicesCreate a custom voice
- DELETE/audio/voice_consents/{consent_id}Delete a voice consent recording
04
Batches
4 endpoints
05
Chat
6 endpoints
- GET/chat/completionsList Chat Completions
- GET/chat/completions/{completion_id}Get chat completion
- GET/chat/completions/{completion_id}/messagesGet chat messages
- POST/chat/completionsCreate a chat completion
- POST/chat/completions/{completion_id}Update a stored chat completion
- DELETE/chat/completions/{completion_id}Delete chat completion
06
Chatkit
6 endpoints
- GET/chatkit/threadsList ChatKit threads
- GET/chatkit/threads/{thread_id}Retrieve a ChatKit thread
- GET/chatkit/threads/{thread_id}/itemsList ChatKit thread items
- POST/chatkit/sessionsCreate a ChatKit session
- POST/chatkit/sessions/{session_id}/cancelCancel a ChatKit session
- DELETE/chatkit/threads/{thread_id}Delete a ChatKit thread
07
Completions
1 endpoint
08
Containers
9 endpoints
- GET/containersList containers
- GET/containers/{container_id}Retrieve a container
- GET/containers/{container_id}/filesList files in a container
- GET/containers/{container_id}/files/{file_id}Retrieve a container file
- GET/containers/{container_id}/files/{file_id}/contentRetrieve container file content
- POST/containersCreate a container
- POST/containers/{container_id}/filesCreate a file in a container
- DELETE/containers/{container_id}Delete a container
- DELETE/containers/{container_id}/files/{file_id}Delete a file from a container
09
Content_provenance_checks
1 endpoint
10
Conversations
8 endpoints
- GET/conversations/{conversation_id}Retrieve a conversation
- GET/conversations/{conversation_id}/itemsList conversation items
- GET/conversations/{conversation_id}/items/{item_id}Retrieve a conversation item
- POST/conversationsCreate a conversation
- POST/conversations/{conversation_id}Update a conversation
- POST/conversations/{conversation_id}/itemsCreate conversation items
- DELETE/conversations/{conversation_id}Delete a conversation
- DELETE/conversations/{conversation_id}/items/{item_id}Delete a conversation item
11
Embeddings
1 endpoint
12
Evals
12 endpoints
- GET/evalsList project evaluations
- GET/evals/{eval_id}Get an evaluation
- GET/evals/{eval_id}/runsList runs for an evaluation
- GET/evals/{eval_id}/runs/{run_id}Get an evaluation run
- GET/evals/{eval_id}/runs/{run_id}/output_itemsList evaluation run output items
- GET/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}Get an eval run output item
- POST/evalsCreate an evaluation
- POST/evals/{eval_id}Update an evaluation
- POST/evals/{eval_id}/runsCreate an evaluation run
- POST/evals/{eval_id}/runs/{run_id}Cancel an evaluation run
- DELETE/evals/{eval_id}Delete an evaluation
- DELETE/evals/{eval_id}/runs/{run_id}Delete an evaluation run
13
Files
5 endpoints
14
Fine_tuning
13 endpoints
- GET/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissionsList checkpoint permissions
- GET/fine_tuning/jobsList fine-tuning jobs
- GET/fine_tuning/jobs/{fine_tuning_job_id}Retrieve a fine-tuning job
- GET/fine_tuning/jobs/{fine_tuning_job_id}/checkpointsList fine-tuning job checkpoints
- GET/fine_tuning/jobs/{fine_tuning_job_id}/eventsList fine-tuning job events
- POST/fine_tuning/alpha/graders/runRun a grader
- POST/fine_tuning/alpha/graders/validateValidate a grader
- POST/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissionsCreate checkpoint permissions
- POST/fine_tuning/jobsCreate a fine-tuning job
- POST/fine_tuning/jobs/{fine_tuning_job_id}/cancelCancel a fine-tuning job
- POST/fine_tuning/jobs/{fine_tuning_job_id}/pausePause a fine-tuning job
- POST/fine_tuning/jobs/{fine_tuning_job_id}/resumeResume a fine-tuning job
- DELETE/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}Delete a fine-tuning checkpoint permission
15
Images
3 endpoints
16
Live
7 endpoints
- GET/live/sessions/{session_id}/contentDownload a Live session recording
- POST/live/sessionsCreate session
- POST/live/sessions/{session_id}/acceptAccept call
- POST/live/sessions/{session_id}/forkFork session
- POST/live/sessions/{session_id}/hangupHang up a Live session
- POST/live/sessions/{session_id}/referTransfer call
- POST/live/sessions/{session_id}/rejectReject call
17
Models
3 endpoints
18
Moderations
1 endpoint
19
Organization
106 endpoints
- GET/organization/admin_api_keysList organization and project API keys
- GET/organization/admin_api_keys/{key_id}Retrieve an organization admin API key
- GET/organization/audit_logsList audit logs
- GET/organization/certificatesList organization certificates
- GET/organization/certificates/{certificate_id}Get certificate
- GET/organization/costsList organization costs
- GET/organization/data_retentionRetrieve organization data retention
- GET/organization/groupsList organization groups
- GET/organization/groups/{group_id}Retrieve an organization group
- GET/organization/groups/{group_id}/rolesList group organization role assignments
- GET/organization/groups/{group_id}/roles/{role_id}Retrieve group organization role
- GET/organization/groups/{group_id}/usersList users in a group
- GET/organization/groups/{group_id}/users/{user_id}Retrieve a user from a group
- GET/organization/invitesList organization invites
- GET/organization/invites/{invite_id}Retrieve an organization invite
- GET/organization/projectsList organization projects
- GET/organization/projects/{project_id}Retrieve an organization project
- GET/organization/projects/{project_id}/api_keysList project API keys
- GET/organization/projects/{project_id}/api_keys/{api_key_id}Retrieve a project API key
- GET/organization/projects/{project_id}/certificatesList project certificates
- GET/organization/projects/{project_id}/data_retentionRetrieve project data retention
- GET/organization/projects/{project_id}/groupsList project groups
- GET/organization/projects/{project_id}/groups/{group_id}Retrieve a project group
- GET/organization/projects/{project_id}/hosted_tool_permissionsRetrieve project hosted tool permissions
- GET/organization/projects/{project_id}/model_permissionsRetrieve project model permissions
- GET/organization/projects/{project_id}/rate_limitsList project rate limits
- GET/organization/projects/{project_id}/service_accountsList project service accounts
- GET/organization/projects/{project_id}/service_accounts/{service_account_id}Retrieve a project service account
- GET/organization/projects/{project_id}/spend_alertsList project spend alerts
- GET/organization/projects/{project_id}/spend_alerts/{alert_id}Retrieve a project spend alert
- GET/organization/projects/{project_id}/spend_limitGet the project spend limit
- GET/organization/projects/{project_id}/usersList project users
- GET/organization/projects/{project_id}/users/{user_id}Retrieve a project user
- GET/organization/rolesList organization roles
- GET/organization/roles/{role_id}Retrieve an organization role
- GET/organization/spend_alertsList organization spend alerts
- GET/organization/spend_alerts/{alert_id}Retrieve an organization spend alert
- GET/organization/spend_limitGet the organization spend limit
- GET/organization/usage/audio_speechesAudio speeches
- GET/organization/usage/audio_transcriptionsAudio transcriptions
- GET/organization/usage/code_interpreter_sessionsCode interpreter sessions
- GET/organization/usage/completionsCompletions
- GET/organization/usage/embeddingsEmbeddings
- GET/organization/usage/file_search_callsFile search calls
- GET/organization/usage/imagesList organization image usage
- GET/organization/usage/moderationsModerations
- GET/organization/usage/vector_storesVector stores
- GET/organization/usage/web_search_callsWeb search calls
- GET/organization/usersList organization users
- GET/organization/users/{user_id}Retrieve an organization user
- GET/organization/users/{user_id}/rolesList user organization role assignments
- GET/organization/users/{user_id}/roles/{role_id}Retrieve user organization role
- POST/organization/admin_api_keysCreate an organization admin API key
- POST/organization/certificatesUpload certificate
- POST/organization/certificates/{certificate_id}Modify certificate
- POST/organization/certificates/activateActivate organization certificates
- POST/organization/certificates/deactivateDeactivate organization certificates
- POST/organization/data_retentionUpdate organization data retention
- POST/organization/groupsCreate an organization group
- POST/organization/groups/{group_id}Update a group
- POST/organization/groups/{group_id}/rolesAssign organization role to group
- POST/organization/groups/{group_id}/usersAdd a user to a group
- POST/organization/invitesCreate invite
- POST/organization/projectsCreate project
- POST/organization/projects/{project_id}Update an organization project
- POST/organization/projects/{project_id}/archiveArchive project
- POST/organization/projects/{project_id}/certificates/activateActivate project certificates
- POST/organization/projects/{project_id}/certificates/deactivateDeactivate project certificates
- POST/organization/projects/{project_id}/data_retentionUpdate project data retention
- POST/organization/projects/{project_id}/groupsAdd a group to a project
- POST/organization/projects/{project_id}/hosted_tool_permissionsModify project hosted tool permissions
- POST/organization/projects/{project_id}/model_permissionsModify project model permissions
- POST/organization/projects/{project_id}/rate_limits/{rate_limit_id}Modify a project rate limit
- POST/organization/projects/{project_id}/service_accountsCreate a project service account
- POST/organization/projects/{project_id}/service_accounts/{service_account_id}Update a project service account
- POST/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keysCreate an API key for a service account
- POST/organization/projects/{project_id}/spend_alertsCreate a project spend alert
- POST/organization/projects/{project_id}/spend_alerts/{alert_id}Update a project spend alert
- POST/organization/projects/{project_id}/spend_limitUpdate the project spend limit
- POST/organization/projects/{project_id}/usersCreate project user
- POST/organization/projects/{project_id}/users/{user_id}Modify a project user's role
- POST/organization/rolesCreate an organization role
- POST/organization/roles/{role_id}Update an organization role
- POST/organization/spend_alertsCreate an organization spend alert
- POST/organization/spend_alerts/{alert_id}Update an organization spend alert
- POST/organization/spend_limitUpdate organization spend limit
- POST/organization/users/{user_id}Modify an organization user's role
- POST/organization/users/{user_id}/rolesAssign organization role to user
- DELETE/organization/admin_api_keys/{key_id}Delete an organization admin API key
- DELETE/organization/certificates/{certificate_id}Delete certificate
- DELETE/organization/groups/{group_id}Delete a group
- DELETE/organization/groups/{group_id}/roles/{role_id}Unassign organization role from group
- DELETE/organization/groups/{group_id}/users/{user_id}Remove a user from a group
- DELETE/organization/invites/{invite_id}Delete invite
- DELETE/organization/projects/{project_id}/api_keys/{api_key_id}Delete project API key
- DELETE/organization/projects/{project_id}/groups/{group_id}Remove a group from a project
- DELETE/organization/projects/{project_id}/model_permissionsDelete project model permissions
- DELETE/organization/projects/{project_id}/service_accounts/{service_account_id}Delete project service account
- DELETE/organization/projects/{project_id}/spend_alerts/{alert_id}Delete a project spend alert
- DELETE/organization/projects/{project_id}/spend_limitDelete the project spend limit
- DELETE/organization/projects/{project_id}/users/{user_id}Delete project user
- DELETE/organization/roles/{role_id}Delete an organization role
- DELETE/organization/spend_alerts/{alert_id}Delete an organization spend alert
- DELETE/organization/spend_limitDelete the organization spend limit
- DELETE/organization/users/{user_id}Delete an organization user
- DELETE/organization/users/{user_id}/roles/{role_id}Unassign organization role from user
20
Projects
13 endpoints
- GET/projects/{project_id}/groups/{group_id}/rolesList project group role assignments
- GET/projects/{project_id}/groups/{group_id}/roles/{role_id}Retrieve a project group role
- GET/projects/{project_id}/rolesList project roles
- GET/projects/{project_id}/roles/{role_id}Retrieve a project role
- GET/projects/{project_id}/users/{user_id}/rolesList project user role assignments
- GET/projects/{project_id}/users/{user_id}/roles/{role_id}Retrieve a project user role
- POST/projects/{project_id}/groups/{group_id}/rolesAssign project role to group
- POST/projects/{project_id}/rolesCreate a project role
- POST/projects/{project_id}/roles/{role_id}Update a project role
- POST/projects/{project_id}/users/{user_id}/rolesAssign project role to user
- DELETE/projects/{project_id}/groups/{group_id}/roles/{role_id}Unassign project role from group
- DELETE/projects/{project_id}/roles/{role_id}Delete a project role
- DELETE/projects/{project_id}/users/{user_id}/roles/{role_id}Unassign project role from user
21
Realtime
9 endpoints
- POST/realtime/callsCreate call
- POST/realtime/calls/{call_id}/acceptAccept an incoming SIP call
- POST/realtime/calls/{call_id}/hangupHang up call
- POST/realtime/calls/{call_id}/referRefer call
- POST/realtime/calls/{call_id}/rejectReject call
- POST/realtime/client_secretsCreate client secret
- POST/realtime/sessionsCreate a Realtime session
- POST/realtime/transcription_sessionsCreate transcription session
- POST/realtime/translations/client_secretsCreate translation client secret
22
Responses
13 endpoints
- GET/responses/{response_id}Get a model response
- GET/responses/{response_id}?beta=trueGet a model response
- GET/responses/{response_id}/input_itemsList response input items
- GET/responses/{response_id}/input_items?beta=trueList response input items
- POST/responsesCreate a model response
- POST/responses/{response_id}/cancelCancel a background response
- POST/responses/{response_id}/cancel?beta=trueCancel a background model response
- POST/responses/compactCompact a conversation
- POST/responses/compact?beta=trueCompact a conversation
- POST/responses/input_tokensGet input token counts
- POST/responses/input_tokens?beta=trueGet input token counts
- DELETE/responses/{response_id}Delete a model response
- DELETE/responses/{response_id}?beta=trueDelete a model response
23
Responses?beta=true
1 endpoint
24
Safety
1 endpoint
25
Skills
11 endpoints
- GET/skillsList skills
- GET/skills/{skill_id}Get a skill
- GET/skills/{skill_id}/contentDownload skill content
- GET/skills/{skill_id}/versionsList skill versions
- GET/skills/{skill_id}/versions/{version}Get a skill version
- GET/skills/{skill_id}/versions/{version}/contentDownload skill version content
- POST/skillsCreate a skill
- POST/skills/{skill_id}Update a skill's default version
- POST/skills/{skill_id}/versionsCreate a skill version
- DELETE/skills/{skill_id}Delete a skill
- DELETE/skills/{skill_id}/versions/{version}Delete a skill version
26
Threads
18 endpoints
- GET/threads/{thread_id}Retrieve a thread
- GET/threads/{thread_id}/messagesList messages in a thread
- GET/threads/{thread_id}/messages/{message_id}Retrieve a thread message
- GET/threads/{thread_id}/runsList runs in a thread
- GET/threads/{thread_id}/runs/{run_id}Retrieve a thread run
- GET/threads/{thread_id}/runs/{run_id}/stepsList the steps in a run
- GET/threads/{thread_id}/runs/{run_id}/steps/{step_id}Retrieve a run step
- POST/threadsCreate a thread
- POST/threads/{thread_id}Modify a thread
- POST/threads/{thread_id}/messagesCreate a message in a thread
- POST/threads/{thread_id}/messages/{message_id}Modify a thread message
- POST/threads/{thread_id}/runsCreate a run for a thread
- POST/threads/{thread_id}/runs/{run_id}Modify a thread run
- POST/threads/{thread_id}/runs/{run_id}/cancelCancel a thread run
- POST/threads/{thread_id}/runs/{run_id}/submit_tool_outputsSubmit tool outputs to a run
- POST/threads/runsCreate a thread and run
- DELETE/threads/{thread_id}Delete a thread
- DELETE/threads/{thread_id}/messages/{message_id}Delete a thread message
27
Uploads
4 endpoints
28
Vaults
9 endpoints
- GET/vaultsList vaults
- GET/vaults/{vault_id}Retrieve a vault
- GET/vaults/{vault_id}/credentialsList vault credentials
- GET/vaults/{vault_id}/credentials/{credential_id}Retrieve a vault credential
- POST/vaultsCreate a vault
- POST/vaults/{vault_id}/credentialsCreate a vault credential
- POST/vaults/{vault_id}/credentials/{credential_id}Rotate a vault credential
- DELETE/vaults/{vault_id}Delete a vault
- DELETE/vaults/{vault_id}/credentials/{credential_id}Delete a vault credential
29
Vector_stores
16 endpoints
- GET/vector_storesList vector stores
- GET/vector_stores/{vector_store_id}Retrieve a vector store
- GET/vector_stores/{vector_store_id}/file_batches/{batch_id}Retrieve a vector store file batch
- GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/filesList files in a vector store batch
- GET/vector_stores/{vector_store_id}/filesList vector store files
- GET/vector_stores/{vector_store_id}/files/{file_id}Retrieve a vector store file
- GET/vector_stores/{vector_store_id}/files/{file_id}/contentRetrieve vector store file content
- POST/vector_storesCreate a vector store
- POST/vector_stores/{vector_store_id}Modify a vector store
- POST/vector_stores/{vector_store_id}/file_batchesCreate a vector store file batch
- POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancelCancel a vector store file batch
- POST/vector_stores/{vector_store_id}/filesCreate a vector store file
- POST/vector_stores/{vector_store_id}/files/{file_id}Update vector store file attributes
- POST/vector_stores/{vector_store_id}/searchSearch a vector store
- DELETE/vector_stores/{vector_store_id}Delete a vector store
- DELETE/vector_stores/{vector_store_id}/files/{file_id}Delete a vector store file
30
Videos
10 endpoints
- GET/videosList videosDeprecated
- GET/videos/{video_id}Retrieve a videoDeprecated
- GET/videos/{video_id}/contentDownload video contentDeprecated
- GET/videos/characters/{character_id}Retrieve a characterDeprecated
- POST/videosCreate a videoDeprecated
- POST/videos/{video_id}/remixCreate a video remixDeprecated
- POST/videos/charactersCreate a characterDeprecated
- POST/videos/editsCreate a video editDeprecated
- POST/videos/extensionsCreate a video extensionDeprecated
- DELETE/videos/{video_id}Delete a videoDeprecated