NAME
OpenAPI::Client::OpenAI::Methods - Index of API methods (snake_case)
METHODS
accept_realtime_call
POST /realtime/calls/{call_id}/accept
operationId: accept-realtime-call
Accept an incoming SIP call and configure the realtime session that will handle it.
See OpenAPI::Client::OpenAI::Path::realtime-calls-call_id-accept.
activate_organization_certificates
POST /organization/certificates/activate
operationId: activateOrganizationCertificates
Activate certificates at the organization level.
You can atomically and idempotently activate up to 10 certificates at a time.
See OpenAPI::Client::OpenAI::Path::organization-certificates-activate.
activate_project_certificates
POST /organization/projects/{project_id}/certificates/activate
operationId: activateProjectCertificates
Activate certificates at the project level.
You can atomically and idempotently activate up to 10 certificates at a time.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-certificates-activate.
add_group_user
POST /organization/groups/{group_id}/users
operationId: add-group-user
Adds a user to a group.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-users.
add_project_group
POST /organization/projects/{project_id}/groups
operationId: add-project-group
Grants a group access to a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-groups.
add_upload_part
POST /uploads/{upload_id}/parts
operationId: addUploadPart
Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.
Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.
It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload .
See OpenAPI::Client::OpenAI::Path::uploads-upload_id-parts.
admin_api_keys_create
POST /organization/admin_api_keys
operationId: admin-api-keys-create
Create an organization admin API key
See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys.
admin_api_keys_delete
DELETE /organization/admin_api_keys/{key_id}
operationId: admin-api-keys-delete
Delete an organization admin API key
See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys-key_id.
admin_api_keys_get
GET /organization/admin_api_keys/{key_id}
operationId: admin-api-keys-get
Retrieve a single organization API key
See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys-key_id.
admin_api_keys_list
GET /organization/admin_api_keys
operationId: admin-api-keys-list
List organization API keys
See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys.
archive_project
POST /organization/projects/{project_id}/archive
operationId: archive-project
Archives a project in the organization. Archived projects cannot be used or updated.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-archive.
assign_group_role
POST /organization/groups/{group_id}/roles
operationId: assign-group-role
Assigns an organization role to a group within the organization.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-roles.
assign_project_group_role
POST /projects/{project_id}/groups/{group_id}/roles
operationId: assign-project-group-role
Assigns a project role to a group within a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-groups-group_id-roles.
assign_project_user_role
POST /projects/{project_id}/users/{user_id}/roles
operationId: assign-project-user-role
Assigns a project role to a user within a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-users-user_id-roles.
assign_user_role
POST /organization/users/{user_id}/roles
operationId: assign-user-role
Assigns an organization role to a user within the organization.
See OpenAPI::Client::OpenAI::Path::organization-users-user_id-roles.
cancel_batch
POST /batches/{batch_id}/cancel
operationId: cancelBatch
Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled , where it will have partial results (if any) available in the output file.
See OpenAPI::Client::OpenAI::Path::batches-batch_id-cancel.
cancel_chat_session_method
POST /chatkit/sessions/{session_id}/cancel
operationId: CancelChatSessionMethod
Cancel an active ChatKit session and return its most recent metadata.
Cancelling prevents new requests from using the issued client secret.
See OpenAPI::Client::OpenAI::Path::chatkit-sessions-session_id-cancel.
cancel_eval_run
POST /evals/{eval_id}/runs/{run_id}
operationId: cancelEvalRun
Cancel an ongoing evaluation run.
See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id.
cancel_fine_tuning_job
POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel
operationId: cancelFineTuningJob
Immediately cancel a fine-tune job.
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-cancel.
cancel_response
POST /responses/{response_id}/cancel
operationId: cancelResponse
Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more .
See OpenAPI::Client::OpenAI::Path::responses-response_id-cancel.
cancel_run
POST /threads/{thread_id}/runs/{run_id}/cancel
operationId: cancelRun
Cancels a run that is in_progress .
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-cancel.
cancel_upload
POST /uploads/{upload_id}/cancel
operationId: cancelUpload
Cancels the Upload. No Parts may be added after an Upload is cancelled.
Returns the Upload object with status cancelled .
See OpenAPI::Client::OpenAI::Path::uploads-upload_id-cancel.
cancel_vector_store_file_batch
POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
operationId: cancelVectorStoreFileBatch
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id-cancel.
compactconversation
POST /responses/compact
operationId: Compactconversation
Compact a conversation. Returns a compacted response object.
Learn when and how to compact long-running conversations in the conversation state guide . For ZDR-compatible compaction details, see Compaction (advanced) .
See OpenAPI::Client::OpenAI::Path::responses-compact.
complete_upload
POST /uploads/{upload_id}/complete
operationId: completeUpload
Completes the Upload .
Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. Returns the Upload object with status completed , including an additional file property containing the created usable File object.
See OpenAPI::Client::OpenAI::Path::uploads-upload_id-complete.
create_assistant
POST /assistants
operationId: createAssistant
Create an assistant with a model and instructions.
See OpenAPI::Client::OpenAI::Path::assistants.
create_batch
POST /batches
operationId: createBatch
Creates and executes a batch from an uploaded file of requests
See OpenAPI::Client::OpenAI::Path::batches.
create_chat_completion
POST /chat/completions
operationId: createChatCompletion
Starting a new project? We recommend trying Responses to take advantage of the latest OpenAI platform features. Compare Chat Completions with Responses .
Creates a model response for the given chat conversation. Learn more in the text generation , vision , and audio guides.
Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide .
Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed.
See OpenAPI::Client::OpenAI::Path::chat-completions.
create_chat_session_method
POST /chatkit/sessions
operationId: CreateChatSessionMethod
Create a ChatKit session.
See OpenAPI::Client::OpenAI::Path::chatkit-sessions.
create_completion
POST /completions
operationId: createCompletion
Creates a completion for the provided prompt and parameters.
Returns a completion object, or a sequence of completion objects if the request is streamed.
See OpenAPI::Client::OpenAI::Path::completions.
create_container
POST /containers
operationId: CreateContainer
Create Container
See OpenAPI::Client::OpenAI::Path::containers.
create_container_file
POST /containers/{container_id}/files
operationId: CreateContainerFile
Create a Container File
You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.
See OpenAPI::Client::OpenAI::Path::containers-container_id-files.
create_conversation
POST /conversations
operationId: createConversation
Create a conversation.
See OpenAPI::Client::OpenAI::Path::conversations.
create_conversation_items
POST /conversations/{conversation_id}/items
operationId: createConversationItems
Create items in a conversation with the given ID.
See OpenAPI::Client::OpenAI::Path::conversations-conversation_id-items.
create_embedding
POST /embeddings
operationId: createEmbedding
Creates an embedding vector representing the input text.
See OpenAPI::Client::OpenAI::Path::embeddings.
create_eval
POST /evals
operationId: createEval
Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the Evals guide .
See OpenAPI::Client::OpenAI::Path::evals.
create_eval_run
POST /evals/{eval_id}/runs
operationId: createEvalRun
Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.
See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs.
create_file
POST /files
operationId: createFile
Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit. Uploads to this endpoint are rate-limited to 1,000 requests per minute per authenticated user.
- The Assistants API supports files up to 2 million tokens and of specific file types. See the Assistants Tools guide for details. - The Fine-tuning API only supports .jsonl files. The input also has certain required formats for fine-tuning chat or completions models. - The Batch API only supports .jsonl files up to 200 MB in size. The input also has a specific required format . - For Retrieval or file_search ingestion, upload files here first. If you need to attach multiple uploaded files to the same vector store, use /vector_stores/{vector_store_id}/file_batches instead of attaching them one by one. Vector store attachment has separate limits from file upload, including 2,000 attached files per minute per organization.
Please contact us if you need to increase these storage limits.
See OpenAPI::Client::OpenAI::Path::files.
create_fine_tuning_checkpoint_permission
POST /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
operationId: createFineTuningCheckpointPermission
NOTE: Calling this endpoint requires an admin API key .
This enables organization owners to share fine-tuned models with other projects in their organization.
See OpenAPI::Client::OpenAI::Path::fine_tuning-checkpoints-fine_tuned_model_checkpoint-permissions.
create_fine_tuning_job
POST /fine_tuning/jobs
operationId: createFineTuningJob
Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs.
create_group
POST /organization/groups
operationId: create-group
Creates a new group in the organization.
See OpenAPI::Client::OpenAI::Path::organization-groups.
create_image
POST /images/generations
operationId: createImage
Creates an image given a prompt. Learn more .
See OpenAPI::Client::OpenAI::Path::images-generations.
create_image_edit
POST /images/edits
operationId: createImageEdit
Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (gpt-image-1.5, gpt-image-1 , gpt-image-1-mini , and chatgpt-image-latest ) and dall-e-2 .
See OpenAPI::Client::OpenAI::Path::images-edits.
create_image_variation
POST /images/variations
operationId: createImageVariation
Creates a variation of a given image. This endpoint only supports dall-e-2 .
See OpenAPI::Client::OpenAI::Path::images-variations.
create_message
POST /threads/{thread_id}/messages
operationId: createMessage
Create a message.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages.
create_moderation
POST /moderations
operationId: createModeration
Classifies if text and/or image inputs are potentially harmful. Learn more in the moderation guide .
See OpenAPI::Client::OpenAI::Path::moderations.
create_organization_spend_alert
POST /organization/spend_alerts
operationId: create-organization-spend-alert
Creates an organization spend alert.
See OpenAPI::Client::OpenAI::Path::organization-spend_alerts.
create_project
POST /organization/projects
operationId: create-project
Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
See OpenAPI::Client::OpenAI::Path::organization-projects.
create_project_role
POST /projects/{project_id}/roles
operationId: create-project-role
Creates a custom role for a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-roles.
create_project_service_account
POST /organization/projects/{project_id}/service_accounts
operationId: create-project-service-account
Creates a new service account in the project. This also returns an unredacted API key for the service account.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts.
create_project_spend_alert
POST /organization/projects/{project_id}/spend_alerts
operationId: create-project-spend-alert
Creates a project spend alert.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-spend_alerts.
create_project_user
POST /organization/projects/{project_id}/users
operationId: create-project-user
Adds a user to the project. Users must already be members of the organization to be added to a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users.
create_realtime_call
POST /realtime/calls
operationId: create-realtime-call
Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection.
See OpenAPI::Client::OpenAI::Path::realtime-calls.
create_realtime_client_secret
POST /realtime/client_secrets
operationId: create-realtime-client-secret
Create a Realtime client secret with an associated session configuration.
Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime API without leaking your main API key. You can configure a custom TTL for each client secret.
You can also attach session configuration options to the client secret, which will be applied to any sessions created using that client secret, but these can also be overridden by the client connection.
Learn more about authentication with client secrets over WebRTC .
Returns the created client secret and the effective session object. The client secret is a string that looks like ek_1234 .
See OpenAPI::Client::OpenAI::Path::realtime-client_secrets.
create_realtime_session
POST /realtime/sessions
operationId: create-realtime-session
Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the session.update client event.
It responds with a session object, plus a client_secret key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.
Returns the created Realtime session object, plus an ephemeral key.
See OpenAPI::Client::OpenAI::Path::realtime-sessions.
create_realtime_transcription_session
POST /realtime/transcription_sessions
operationId: create-realtime-transcription-session
Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the transcription_session.update client event.
It responds with a session object, plus a client_secret key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.
Returns the created Realtime transcription session object, plus an ephemeral key.
See OpenAPI::Client::OpenAI::Path::realtime-transcription_sessions.
create_realtime_translation_client_secret
POST /realtime/translations/client_secrets
operationId: create-realtime-translation-client-secret
Create a Realtime translation client secret with an associated translation session configuration.
Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime Translation API without leaking your main API key. You can configure a custom TTL for each client secret.
Returns the created client secret and the effective translation session object. The client secret is a string that looks like ek_1234 .
See OpenAPI::Client::OpenAI::Path::realtime-translations-client_secrets.
create_response
POST /responses
operationId: createResponse
Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.
See OpenAPI::Client::OpenAI::Path::responses.
create_role
POST /organization/roles
operationId: create-role
Creates a custom role for the organization.
See OpenAPI::Client::OpenAI::Path::organization-roles.
create_run
POST /threads/{thread_id}/runs
operationId: createRun
Create a run.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs.
create_skill
POST /skills
operationId: CreateSkill
Create a new skill.
See OpenAPI::Client::OpenAI::Path::skills.
create_skill_version
POST /skills/{skill_id}/versions
operationId: CreateSkillVersion
Create a new immutable skill version.
See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions.
create_speech
POST /audio/speech
operationId: createSpeech
Generates audio from the input text.
Returns the audio file content, or a stream of audio events.
See OpenAPI::Client::OpenAI::Path::audio-speech.
create_thread
POST /threads
operationId: createThread
Create a thread.
See OpenAPI::Client::OpenAI::Path::threads.
create_thread_and_run
POST /threads/runs
operationId: createThreadAndRun
Create a thread and run it in one request.
See OpenAPI::Client::OpenAI::Path::threads-runs.
create_transcription
POST /audio/transcriptions
operationId: createTranscription
Transcribes audio into the input language.
Returns a transcription object in json , diarized_json , or verbose_json format, or a stream of transcript events.
See OpenAPI::Client::OpenAI::Path::audio-transcriptions.
create_translation
POST /audio/translations
operationId: createTranslation
Translates audio into English.
See OpenAPI::Client::OpenAI::Path::audio-translations.
create_upload
POST /uploads
operationId: createUpload
Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.
Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.
For certain purpose values, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case .
For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File .
Returns the Upload object with status pending .
See OpenAPI::Client::OpenAI::Path::uploads.
create_vector_store
POST /vector_stores
operationId: createVectorStore
Create a vector store.
See OpenAPI::Client::OpenAI::Path::vector_stores.
create_vector_store_file
POST /vector_stores/{vector_store_id}/files
operationId: createVectorStoreFile
Create a vector store file by attaching a File to a vector store .
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files.
create_vector_store_file_batch
POST /vector_stores/{vector_store_id}/file_batches
operationId: createVectorStoreFileBatch
Create a vector store file batch.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches.
create_video
POST /videos
operationId: createVideo
Create a new video generation job from a prompt and optional reference assets.
See OpenAPI::Client::OpenAI::Path::videos.
create_video_character
POST /videos/characters
operationId: CreateVideoCharacter
Create a character from an uploaded video.
See OpenAPI::Client::OpenAI::Path::videos-characters.
create_video_edit
POST /videos/edits
operationId: CreateVideoEdit
Create a new video generation job by editing a source video or existing generated video.
See OpenAPI::Client::OpenAI::Path::videos-edits.
create_video_extend
POST /videos/extensions
operationId: CreateVideoExtend
Create an extension of a completed video.
See OpenAPI::Client::OpenAI::Path::videos-extensions.
create_video_remix
POST /videos/{video_id}/remix
operationId: CreateVideoRemix
Create a remix of a completed video using a refreshed prompt.
See OpenAPI::Client::OpenAI::Path::videos-video_id-remix.
create_voice
POST /audio/voices
operationId: createVoice
Creates a custom voice.
See OpenAPI::Client::OpenAI::Path::audio-voices.
create_voice_consent
POST /audio/voice_consents
operationId: createVoiceConsent
Upload a voice consent recording.
See OpenAPI::Client::OpenAI::Path::audio-voice_consents.
deactivate_organization_certificates
POST /organization/certificates/deactivate
operationId: deactivateOrganizationCertificates
Deactivate certificates at the organization level.
You can atomically and idempotently deactivate up to 10 certificates at a time.
See OpenAPI::Client::OpenAI::Path::organization-certificates-deactivate.
deactivate_project_certificates
POST /organization/projects/{project_id}/certificates/deactivate
operationId: deactivateProjectCertificates
Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-certificates-deactivate.
delete_assistant
DELETE /assistants/{assistant_id}
operationId: deleteAssistant
Delete an assistant.
See OpenAPI::Client::OpenAI::Path::assistants-assistant_id.
delete_certificate
DELETE /organization/certificates/{certificate_id}
operationId: deleteCertificate
Delete a certificate from the organization.
The certificate must be inactive for the organization and all projects.
See OpenAPI::Client::OpenAI::Path::organization-certificates-certificate_id.
delete_chat_completion
DELETE /chat/completions/{completion_id}
operationId: deleteChatCompletion
Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.
See OpenAPI::Client::OpenAI::Path::chat-completions-completion_id.
delete_container
DELETE /containers/{container_id}
operationId: DeleteContainer
Delete Container
See OpenAPI::Client::OpenAI::Path::containers-container_id.
delete_container_file
DELETE /containers/{container_id}/files/{file_id}
operationId: DeleteContainerFile
Delete Container File
See OpenAPI::Client::OpenAI::Path::containers-container_id-files-file_id.
delete_conversation
DELETE /conversations/{conversation_id}
operationId: deleteConversation
Delete a conversation. Items in the conversation will not be deleted.
See OpenAPI::Client::OpenAI::Path::conversations-conversation_id.
delete_conversation_item
DELETE /conversations/{conversation_id}/items/{item_id}
operationId: deleteConversationItem
Delete an item from a conversation with the given IDs.
See OpenAPI::Client::OpenAI::Path::conversations-conversation_id-items-item_id.
delete_eval
DELETE /evals/{eval_id}
operationId: deleteEval
Delete an evaluation.
See OpenAPI::Client::OpenAI::Path::evals-eval_id.
delete_eval_run
DELETE /evals/{eval_id}/runs/{run_id}
operationId: deleteEvalRun
Delete an eval run.
See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id.
delete_file
DELETE /files/{file_id}
operationId: deleteFile
Delete a file and remove it from all vector stores.
See OpenAPI::Client::OpenAI::Path::files-file_id.
delete_fine_tuning_checkpoint_permission
DELETE /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}
operationId: deleteFineTuningCheckpointPermission
NOTE: This endpoint requires an admin API key .
Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.
delete_group
DELETE /organization/groups/{group_id}
operationId: delete-group
Deletes a group from the organization.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id.
delete_invite
DELETE /organization/invites/{invite_id}
operationId: delete-invite
Delete an invite. If the invite has already been accepted, it cannot be deleted.
See OpenAPI::Client::OpenAI::Path::organization-invites-invite_id.
delete_message
DELETE /threads/{thread_id}/messages/{message_id}
operationId: deleteMessage
Deletes a message.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages-message_id.
delete_model
DELETE /models/{model}
operationId: deleteModel
Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
See OpenAPI::Client::OpenAI::Path::models-model.
delete_organization_spend_alert
DELETE /organization/spend_alerts/{alert_id}
operationId: delete-organization-spend-alert
Deletes an organization spend alert.
See OpenAPI::Client::OpenAI::Path::organization-spend_alerts-alert_id.
delete_project_api_key
DELETE /organization/projects/{project_id}/api_keys/{api_key_id}
operationId: delete-project-api-key
Deletes an API key from the project.
Returns confirmation of the key deletion, or an error if the key belonged to a service account.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-api_keys-api_key_id.
delete_project_model_permissions
DELETE /organization/projects/{project_id}/model_permissions
operationId: delete-project-model-permissions
Deletes model permissions for a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-model_permissions.
delete_project_role
DELETE /projects/{project_id}/roles/{role_id}
operationId: delete-project-role
Deletes a custom role from a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-roles-role_id.
delete_project_service_account
DELETE /organization/projects/{project_id}/service_accounts/{service_account_id}
operationId: delete-project-service-account
Deletes a service account from the project.
Returns confirmation of service account deletion, or an error if the project is archived (archived projects have no service accounts).
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts-service_account_id.
delete_project_spend_alert
DELETE /organization/projects/{project_id}/spend_alerts/{alert_id}
operationId: delete-project-spend-alert
Deletes a project spend alert.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-spend_alerts-alert_id.
delete_project_user
DELETE /organization/projects/{project_id}/users/{user_id}
operationId: delete-project-user
Deletes a user from the project.
Returns confirmation of project user deletion, or an error if the project is archived (archived projects have no users).
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users-user_id.
delete_response
DELETE /responses/{response_id}
operationId: deleteResponse
Deletes a model response with the given ID.
See OpenAPI::Client::OpenAI::Path::responses-response_id.
delete_role
DELETE /organization/roles/{role_id}
operationId: delete-role
Deletes a custom role from the organization.
See OpenAPI::Client::OpenAI::Path::organization-roles-role_id.
delete_skill
DELETE /skills/{skill_id}
operationId: DeleteSkill
Delete a skill by its ID.
See OpenAPI::Client::OpenAI::Path::skills-skill_id.
delete_skill_version
DELETE /skills/{skill_id}/versions/{version}
operationId: DeleteSkillVersion
Delete a skill version.
See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions-version.
delete_thread
DELETE /threads/{thread_id}
operationId: deleteThread
Delete a thread.
See OpenAPI::Client::OpenAI::Path::threads-thread_id.
delete_thread_method
DELETE /chatkit/threads/{thread_id}
operationId: DeleteThreadMethod
Delete a ChatKit thread along with its items and stored attachments.
See OpenAPI::Client::OpenAI::Path::chatkit-threads-thread_id.
delete_user
DELETE /organization/users/{user_id}
operationId: delete-user
Deletes a user from the organization.
See OpenAPI::Client::OpenAI::Path::organization-users-user_id.
delete_vector_store
DELETE /vector_stores/{vector_store_id}
operationId: deleteVectorStore
Delete a vector store.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id.
delete_vector_store_file
DELETE /vector_stores/{vector_store_id}/files/{file_id}
operationId: deleteVectorStoreFile
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files-file_id.
delete_video
DELETE /videos/{video_id}
operationId: DeleteVideo
Permanently delete a completed or failed video and its stored assets.
See OpenAPI::Client::OpenAI::Path::videos-video_id.
delete_voice_consent
DELETE /audio/voice_consents/{consent_id}
operationId: deleteVoiceConsent
Deletes a voice consent recording.
See OpenAPI::Client::OpenAI::Path::audio-voice_consents-consent_id.
download_file
GET /files/{file_id}/content
operationId: downloadFile
Returns the contents of the specified file.
See OpenAPI::Client::OpenAI::Path::files-file_id-content.
get_assistant
GET /assistants/{assistant_id}
operationId: getAssistant
Retrieves an assistant.
See OpenAPI::Client::OpenAI::Path::assistants-assistant_id.
get_certificate
GET /organization/certificates/{certificate_id}
operationId: getCertificate
Get a certificate that has been uploaded to the organization.
You can get a certificate regardless of whether it is active or not.
See OpenAPI::Client::OpenAI::Path::organization-certificates-certificate_id.
get_chat_completion
GET /chat/completions/{completion_id}
operationId: getChatCompletion
Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.
See OpenAPI::Client::OpenAI::Path::chat-completions-completion_id.
get_chat_completion_messages
GET /chat/completions/{completion_id}/messages
operationId: getChatCompletionMessages
Get the messages in a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.
See OpenAPI::Client::OpenAI::Path::chat-completions-completion_id-messages.
get_conversation
GET /conversations/{conversation_id}
operationId: getConversation
Get a conversation
See OpenAPI::Client::OpenAI::Path::conversations-conversation_id.
get_conversation_item
GET /conversations/{conversation_id}/items/{item_id}
operationId: getConversationItem
Get a single item from a conversation with the given IDs.
See OpenAPI::Client::OpenAI::Path::conversations-conversation_id-items-item_id.
get_eval
GET /evals/{eval_id}
operationId: getEval
Get an evaluation by ID.
See OpenAPI::Client::OpenAI::Path::evals-eval_id.
get_eval_run
GET /evals/{eval_id}/runs/{run_id}
operationId: getEvalRun
Get an evaluation run by ID.
See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id.
get_eval_run_output_item
GET /evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
operationId: getEvalRunOutputItem
Get an evaluation run output item by ID.
See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id-output_items-output_item_id.
get_eval_run_output_items
GET /evals/{eval_id}/runs/{run_id}/output_items
operationId: getEvalRunOutputItems
Get a list of output items for an evaluation run.
See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id-output_items.
get_eval_runs
GET /evals/{eval_id}/runs
operationId: getEvalRuns
Get a list of runs for an evaluation.
See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs.
get_message
GET /threads/{thread_id}/messages/{message_id}
operationId: getMessage
Retrieve a message.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages-message_id.
get_response
GET /responses/{response_id}
operationId: getResponse
Retrieves a model response with the given ID.
See OpenAPI::Client::OpenAI::Path::responses-response_id.
get_run
GET /threads/{thread_id}/runs/{run_id}
operationId: getRun
Retrieves a run.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id.
get_run_step
GET /threads/{thread_id}/runs/{run_id}/steps/{step_id}
operationId: getRunStep
Retrieves a run step.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-steps-step_id.
get_skill
GET /skills/{skill_id}
operationId: GetSkill
Get a skill by its ID.
See OpenAPI::Client::OpenAI::Path::skills-skill_id.
get_skill_content
GET /skills/{skill_id}/content
operationId: GetSkillContent
Download a skill zip bundle by its ID.
See OpenAPI::Client::OpenAI::Path::skills-skill_id-content.
get_skill_version
GET /skills/{skill_id}/versions/{version}
operationId: GetSkillVersion
Get a specific skill version.
See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions-version.
get_skill_version_content
GET /skills/{skill_id}/versions/{version}/content
operationId: GetSkillVersionContent
Download a skill version zip bundle.
See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions-version-content.
get_thread
GET /threads/{thread_id}
operationId: getThread
Retrieves a thread.
See OpenAPI::Client::OpenAI::Path::threads-thread_id.
get_thread_method
GET /chatkit/threads/{thread_id}
operationId: GetThreadMethod
Retrieve a ChatKit thread by its identifier.
See OpenAPI::Client::OpenAI::Path::chatkit-threads-thread_id.
get_vector_store
GET /vector_stores/{vector_store_id}
operationId: getVectorStore
Retrieves a vector store.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id.
get_vector_store_file
GET /vector_stores/{vector_store_id}/files/{file_id}
operationId: getVectorStoreFile
Retrieves a vector store file.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files-file_id.
get_vector_store_file_batch
GET /vector_stores/{vector_store_id}/file_batches/{batch_id}
operationId: getVectorStoreFileBatch
Retrieves a vector store file batch.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id.
get_video
GET /videos/{video_id}
operationId: GetVideo
Fetch the latest metadata for a generated video.
See OpenAPI::Client::OpenAI::Path::videos-video_id.
get_video_character
GET /videos/characters/{character_id}
operationId: GetVideoCharacter
Fetch a character.
See OpenAPI::Client::OpenAI::Path::videos-characters-character_id.
get_voice_consent
GET /audio/voice_consents/{consent_id}
operationId: getVoiceConsent
Retrieves a voice consent recording.
See OpenAPI::Client::OpenAI::Path::audio-voice_consents-consent_id.
getinputtokencounts
POST /responses/input_tokens
operationId: Getinputtokencounts
Returns input token counts of the request.
Returns an object with object set to response.input_tokens and an input_tokens count.
See OpenAPI::Client::OpenAI::Path::responses-input_tokens.
hangup_realtime_call
POST /realtime/calls/{call_id}/hangup
operationId: hangup-realtime-call
End an active Realtime API call, whether it was initiated over SIP or WebRTC.
See OpenAPI::Client::OpenAI::Path::realtime-calls-call_id-hangup.
invite_user
POST /organization/invites
operationId: inviteUser
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
See OpenAPI::Client::OpenAI::Path::organization-invites.
list_assistants
GET /assistants
operationId: listAssistants
Returns a list of assistants.
See OpenAPI::Client::OpenAI::Path::assistants.
list_audit_logs
GET /organization/audit_logs
operationId: list-audit-logs
List user actions and configuration changes within this organization.
See OpenAPI::Client::OpenAI::Path::organization-audit_logs.
list_batches
GET /batches
operationId: listBatches
List your organization's batches.
See OpenAPI::Client::OpenAI::Path::batches.
list_chat_completions
GET /chat/completions
operationId: listChatCompletions
List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.
See OpenAPI::Client::OpenAI::Path::chat-completions.
list_container_files
GET /containers/{container_id}/files
operationId: ListContainerFiles
List Container files
See OpenAPI::Client::OpenAI::Path::containers-container_id-files.
list_containers
GET /containers
operationId: ListContainers
List Containers
See OpenAPI::Client::OpenAI::Path::containers.
list_conversation_items
GET /conversations/{conversation_id}/items
operationId: listConversationItems
List all items for a conversation with the given ID.
See OpenAPI::Client::OpenAI::Path::conversations-conversation_id-items.
list_evals
GET /evals
operationId: listEvals
List evaluations for a project.
See OpenAPI::Client::OpenAI::Path::evals.
list_files
GET /files
operationId: listFiles
Returns a list of files.
See OpenAPI::Client::OpenAI::Path::files.
list_files_in_vector_store_batch
GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files
operationId: listFilesInVectorStoreBatch
Returns a list of vector store files in a batch.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id-files.
list_fine_tuning_checkpoint_permissions
GET /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
operationId: listFineTuningCheckpointPermissions
NOTE: This endpoint requires an admin API key .
Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.
See OpenAPI::Client::OpenAI::Path::fine_tuning-checkpoints-fine_tuned_model_checkpoint-permissions.
list_fine_tuning_events
GET /fine_tuning/jobs/{fine_tuning_job_id}/events
operationId: listFineTuningEvents
Get status updates for a fine-tuning job.
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-events.
list_fine_tuning_job_checkpoints
GET /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
operationId: listFineTuningJobCheckpoints
List checkpoints for a fine-tuning job.
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-checkpoints.
list_group_role_assignments
GET /organization/groups/{group_id}/roles
operationId: list-group-role-assignments
Lists the organization roles assigned to a group within the organization.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-roles.
list_group_users
GET /organization/groups/{group_id}/users
operationId: list-group-users
Lists the users assigned to a group.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-users.
list_groups
GET /organization/groups
operationId: list-groups
Lists all groups in the organization.
See OpenAPI::Client::OpenAI::Path::organization-groups.
list_input_items
GET /responses/{response_id}/input_items
operationId: listInputItems
Returns a list of input items for a given response.
See OpenAPI::Client::OpenAI::Path::responses-response_id-input_items.
list_invites
GET /organization/invites
operationId: list-invites
Returns a list of invites in the organization.
See OpenAPI::Client::OpenAI::Path::organization-invites.
list_messages
GET /threads/{thread_id}/messages
operationId: listMessages
Returns a list of messages for a given thread.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages.
list_models
GET /models
operationId: listModels
Lists the currently available models, and provides basic information about each one such as the owner and availability.
See OpenAPI::Client::OpenAI::Path::models.
list_organization_certificates
GET /organization/certificates
operationId: listOrganizationCertificates
List uploaded certificates for this organization.
See OpenAPI::Client::OpenAI::Path::organization-certificates.
list_organization_spend_alerts
GET /organization/spend_alerts
operationId: list-organization-spend-alerts
Lists organization spend alerts.
See OpenAPI::Client::OpenAI::Path::organization-spend_alerts.
list_paginated_fine_tuning_jobs
GET /fine_tuning/jobs
operationId: listPaginatedFineTuningJobs
List your organization's fine-tuning jobs
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs.
list_project_api_keys
GET /organization/projects/{project_id}/api_keys
operationId: list-project-api-keys
Returns a list of API keys in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-api_keys.
list_project_certificates
GET /organization/projects/{project_id}/certificates
operationId: listProjectCertificates
List certificates for this project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-certificates.
list_project_group_role_assignments
GET /projects/{project_id}/groups/{group_id}/roles
operationId: list-project-group-role-assignments
Lists the project roles assigned to a group within a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-groups-group_id-roles.
list_project_groups
GET /organization/projects/{project_id}/groups
operationId: list-project-groups
Lists the groups that have access to a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-groups.
list_project_rate_limits
GET /organization/projects/{project_id}/rate_limits
operationId: list-project-rate-limits
Returns the rate limits per model for a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-rate_limits.
list_project_roles
GET /projects/{project_id}/roles
operationId: list-project-roles
Lists the roles configured for a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-roles.
list_project_service_accounts
GET /organization/projects/{project_id}/service_accounts
operationId: list-project-service-accounts
Returns a list of service accounts in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts.
list_project_spend_alerts
GET /organization/projects/{project_id}/spend_alerts
operationId: list-project-spend-alerts
Lists project spend alerts.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-spend_alerts.
list_project_user_role_assignments
GET /projects/{project_id}/users/{user_id}/roles
operationId: list-project-user-role-assignments
Lists the project roles assigned to a user within a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-users-user_id-roles.
list_project_users
GET /organization/projects/{project_id}/users
operationId: list-project-users
Returns a list of users in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users.
list_projects
GET /organization/projects
operationId: list-projects
Returns a list of projects.
See OpenAPI::Client::OpenAI::Path::organization-projects.
list_roles
GET /organization/roles
operationId: list-roles
Lists the roles configured for the organization.
See OpenAPI::Client::OpenAI::Path::organization-roles.
list_run_steps
GET /threads/{thread_id}/runs/{run_id}/steps
operationId: listRunSteps
Returns a list of run steps belonging to a run.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-steps.
list_runs
GET /threads/{thread_id}/runs
operationId: listRuns
Returns a list of runs belonging to a thread.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs.
list_skill_versions
GET /skills/{skill_id}/versions
operationId: ListSkillVersions
List skill versions for a skill.
See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions.
list_skills
GET /skills
operationId: ListSkills
List all skills for the current project.
See OpenAPI::Client::OpenAI::Path::skills.
list_thread_items_method
GET /chatkit/threads/{thread_id}/items
operationId: ListThreadItemsMethod
List items that belong to a ChatKit thread.
See OpenAPI::Client::OpenAI::Path::chatkit-threads-thread_id-items.
list_threads_method
GET /chatkit/threads
operationId: ListThreadsMethod
List ChatKit threads with optional pagination and user filters.
See OpenAPI::Client::OpenAI::Path::chatkit-threads.
list_user_role_assignments
GET /organization/users/{user_id}/roles
operationId: list-user-role-assignments
Lists the organization roles assigned to a user within the organization.
See OpenAPI::Client::OpenAI::Path::organization-users-user_id-roles.
list_users
GET /organization/users
operationId: list-users
Lists all of the users in the organization.
See OpenAPI::Client::OpenAI::Path::organization-users.
list_vector_store_files
GET /vector_stores/{vector_store_id}/files
operationId: listVectorStoreFiles
Returns a list of vector store files.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files.
list_vector_stores
GET /vector_stores
operationId: listVectorStores
Returns a list of vector stores.
See OpenAPI::Client::OpenAI::Path::vector_stores.
list_videos
GET /videos
operationId: ListVideos
List recently generated videos for the current project.
See OpenAPI::Client::OpenAI::Path::videos.
list_voice_consents
GET /audio/voice_consents
operationId: listVoiceConsents
Returns a list of voice consent recordings.
See OpenAPI::Client::OpenAI::Path::audio-voice_consents.
modify_assistant
POST /assistants/{assistant_id}
operationId: modifyAssistant
Modifies an assistant.
See OpenAPI::Client::OpenAI::Path::assistants-assistant_id.
modify_certificate
POST /organization/certificates/{certificate_id}
operationId: modifyCertificate
Modify a certificate. Note that only the name can be modified.
See OpenAPI::Client::OpenAI::Path::organization-certificates-certificate_id.
modify_message
POST /threads/{thread_id}/messages/{message_id}
operationId: modifyMessage
Modifies a message.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages-message_id.
modify_project
POST /organization/projects/{project_id}
operationId: modify-project
Modifies a project in the organization.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id.
modify_project_user
POST /organization/projects/{project_id}/users/{user_id}
operationId: modify-project-user
Modifies a user's role in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users-user_id.
modify_run
POST /threads/{thread_id}/runs/{run_id}
operationId: modifyRun
Modifies a run.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id.
modify_thread
POST /threads/{thread_id}
operationId: modifyThread
Modifies a thread.
See OpenAPI::Client::OpenAI::Path::threads-thread_id.
modify_user
POST /organization/users/{user_id}
operationId: modify-user
Modifies a user's role in the organization.
See OpenAPI::Client::OpenAI::Path::organization-users-user_id.
modify_vector_store
POST /vector_stores/{vector_store_id}
operationId: modifyVectorStore
Modifies a vector store.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id.
pause_fine_tuning_job
POST /fine_tuning/jobs/{fine_tuning_job_id}/pause
operationId: pauseFineTuningJob
Pause a fine-tune job.
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-pause.
refer_realtime_call
POST /realtime/calls/{call_id}/refer
operationId: refer-realtime-call
Transfer an active SIP call to a new destination using the SIP REFER verb.
See OpenAPI::Client::OpenAI::Path::realtime-calls-call_id-refer.
reject_realtime_call
POST /realtime/calls/{call_id}/reject
operationId: reject-realtime-call
Decline an incoming SIP call by returning a SIP status code to the caller.
See OpenAPI::Client::OpenAI::Path::realtime-calls-call_id-reject.
remove_group_user
DELETE /organization/groups/{group_id}/users/{user_id}
operationId: remove-group-user
Removes a user from a group.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-users-user_id.
remove_project_group
DELETE /organization/projects/{project_id}/groups/{group_id}
operationId: remove-project-group
Revokes a group's access to a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-groups-group_id.
resume_fine_tuning_job
POST /fine_tuning/jobs/{fine_tuning_job_id}/resume
operationId: resumeFineTuningJob
Resume a fine-tune job.
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-resume.
retrieve_batch
GET /batches/{batch_id}
operationId: retrieveBatch
Retrieves a batch.
See OpenAPI::Client::OpenAI::Path::batches-batch_id.
retrieve_container
GET /containers/{container_id}
operationId: RetrieveContainer
Retrieve Container
See OpenAPI::Client::OpenAI::Path::containers-container_id.
retrieve_container_file
GET /containers/{container_id}/files/{file_id}
operationId: RetrieveContainerFile
Retrieve Container File
See OpenAPI::Client::OpenAI::Path::containers-container_id-files-file_id.
retrieve_container_file_content
GET /containers/{container_id}/files/{file_id}/content
operationId: RetrieveContainerFileContent
Retrieve Container File Content
See OpenAPI::Client::OpenAI::Path::containers-container_id-files-file_id-content.
retrieve_file
GET /files/{file_id}
operationId: retrieveFile
Returns information about a specific file.
See OpenAPI::Client::OpenAI::Path::files-file_id.
retrieve_fine_tuning_job
GET /fine_tuning/jobs/{fine_tuning_job_id}
operationId: retrieveFineTuningJob
Get info about a fine-tuning job.
See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id.
retrieve_group
GET /organization/groups/{group_id}
operationId: retrieve-group
Retrieves a group.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id.
retrieve_group_role
GET /organization/groups/{group_id}/roles/{role_id}
operationId: retrieve-group-role
Retrieves an organization role assigned to a group.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-roles-role_id.
retrieve_group_user
GET /organization/groups/{group_id}/users/{user_id}
operationId: retrieve-group-user
Retrieves a user in a group.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-users-user_id.
retrieve_invite
GET /organization/invites/{invite_id}
operationId: retrieve-invite
Retrieves an invite.
See OpenAPI::Client::OpenAI::Path::organization-invites-invite_id.
retrieve_model
GET /models/{model}
operationId: retrieveModel
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
See OpenAPI::Client::OpenAI::Path::models-model.
retrieve_organization_data_retention
GET /organization/data_retention
operationId: retrieve-organization-data-retention
Retrieves organization data retention controls.
See OpenAPI::Client::OpenAI::Path::organization-data_retention.
retrieve_project
GET /organization/projects/{project_id}
operationId: retrieve-project
Retrieves a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id.
retrieve_project_api_key
GET /organization/projects/{project_id}/api_keys/{api_key_id}
operationId: retrieve-project-api-key
Retrieves an API key in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-api_keys-api_key_id.
retrieve_project_data_retention
GET /organization/projects/{project_id}/data_retention
operationId: retrieve-project-data-retention
Retrieves project data retention controls.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-data_retention.
retrieve_project_group
GET /organization/projects/{project_id}/groups/{group_id}
operationId: retrieve-project-group
Retrieves a project's group.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-groups-group_id.
retrieve_project_group_role
GET /projects/{project_id}/groups/{group_id}/roles/{role_id}
operationId: retrieve-project-group-role
Retrieves a project role assigned to a group.
See OpenAPI::Client::OpenAI::Path::projects-project_id-groups-group_id-roles-role_id.
retrieve_project_hosted_tool_permissions
GET /organization/projects/{project_id}/hosted_tool_permissions
operationId: retrieve-project-hosted-tool-permissions
Returns hosted tool permissions for a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-hosted_tool_permissions.
retrieve_project_model_permissions
GET /organization/projects/{project_id}/model_permissions
operationId: retrieve-project-model-permissions
Returns model permissions for a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-model_permissions.
retrieve_project_role
GET /projects/{project_id}/roles/{role_id}
operationId: retrieve-project-role
Retrieves a project role.
See OpenAPI::Client::OpenAI::Path::projects-project_id-roles-role_id.
retrieve_project_service_account
GET /organization/projects/{project_id}/service_accounts/{service_account_id}
operationId: retrieve-project-service-account
Retrieves a service account in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts-service_account_id.
retrieve_project_user
GET /organization/projects/{project_id}/users/{user_id}
operationId: retrieve-project-user
Retrieves a user in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users-user_id.
retrieve_project_user_role
GET /projects/{project_id}/users/{user_id}/roles/{role_id}
operationId: retrieve-project-user-role
Retrieves a project role assigned to a user.
See OpenAPI::Client::OpenAI::Path::projects-project_id-users-user_id-roles-role_id.
retrieve_role
GET /organization/roles/{role_id}
operationId: retrieve-role
Retrieves an organization role.
See OpenAPI::Client::OpenAI::Path::organization-roles-role_id.
retrieve_user
GET /organization/users/{user_id}
operationId: retrieve-user
Retrieves a user by their identifier.
See OpenAPI::Client::OpenAI::Path::organization-users-user_id.
retrieve_user_role
GET /organization/users/{user_id}/roles/{role_id}
operationId: retrieve-user-role
Retrieves an organization role assigned to a user.
See OpenAPI::Client::OpenAI::Path::organization-users-user_id-roles-role_id.
retrieve_vector_store_file_content
GET /vector_stores/{vector_store_id}/files/{file_id}/content
operationId: retrieveVectorStoreFileContent
Retrieve the parsed contents of a vector store file.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files-file_id-content.
retrieve_video_content
GET /videos/{video_id}/content
operationId: RetrieveVideoContent
Download the generated video bytes or a derived preview asset.
Streams the rendered video content for the specified video job.
See OpenAPI::Client::OpenAI::Path::videos-video_id-content.
run_grader
POST /fine_tuning/alpha/graders/run
operationId: runGrader
Run a grader.
See OpenAPI::Client::OpenAI::Path::fine_tuning-alpha-graders-run.
search_vector_store
POST /vector_stores/{vector_store_id}/search
operationId: searchVectorStore
Search a vector store for relevant chunks based on a query and file attributes filter.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-search.
submit_tool_ouputs_to_run
POST /threads/{thread_id}/runs/{run_id}/submit_tool_outputs
operationId: submitToolOuputsToRun
When a run has the status: "requires_action" and required_action.type is submit_tool_outputs , this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-submit_tool_outputs.
unassign_group_role
DELETE /organization/groups/{group_id}/roles/{role_id}
operationId: unassign-group-role
Unassigns an organization role from a group within the organization.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-roles-role_id.
unassign_project_group_role
DELETE /projects/{project_id}/groups/{group_id}/roles/{role_id}
operationId: unassign-project-group-role
Unassigns a project role from a group within a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-groups-group_id-roles-role_id.
unassign_project_user_role
DELETE /projects/{project_id}/users/{user_id}/roles/{role_id}
operationId: unassign-project-user-role
Unassigns a project role from a user within a project.
See OpenAPI::Client::OpenAI::Path::projects-project_id-users-user_id-roles-role_id.
unassign_user_role
DELETE /organization/users/{user_id}/roles/{role_id}
operationId: unassign-user-role
Unassigns an organization role from a user within the organization.
See OpenAPI::Client::OpenAI::Path::organization-users-user_id-roles-role_id.
update_chat_completion
POST /chat/completions/{completion_id}
operationId: updateChatCompletion
Modify a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field.
See OpenAPI::Client::OpenAI::Path::chat-completions-completion_id.
update_conversation
POST /conversations/{conversation_id}
operationId: updateConversation
Update a conversation
See OpenAPI::Client::OpenAI::Path::conversations-conversation_id.
update_eval
POST /evals/{eval_id}
operationId: updateEval
Update certain properties of an evaluation.
See OpenAPI::Client::OpenAI::Path::evals-eval_id.
update_group
POST /organization/groups/{group_id}
operationId: update-group
Updates a group's information.
See OpenAPI::Client::OpenAI::Path::organization-groups-group_id.
update_organization_data_retention
POST /organization/data_retention
operationId: update-organization-data-retention
Updates organization data retention controls.
See OpenAPI::Client::OpenAI::Path::organization-data_retention.
update_organization_spend_alert
POST /organization/spend_alerts/{alert_id}
operationId: update-organization-spend-alert
Updates an organization spend alert.
See OpenAPI::Client::OpenAI::Path::organization-spend_alerts-alert_id.
update_project_data_retention
POST /organization/projects/{project_id}/data_retention
operationId: update-project-data-retention
Updates project data retention controls.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-data_retention.
update_project_hosted_tool_permissions
POST /organization/projects/{project_id}/hosted_tool_permissions
operationId: update-project-hosted-tool-permissions
Updates hosted tool permissions for a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-hosted_tool_permissions.
update_project_model_permissions
POST /organization/projects/{project_id}/model_permissions
operationId: update-project-model-permissions
Updates model permissions for a project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-model_permissions.
update_project_rate_limits
POST /organization/projects/{project_id}/rate_limits/{rate_limit_id}
operationId: update-project-rate-limits
Updates a project rate limit.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-rate_limits-rate_limit_id.
update_project_role
POST /projects/{project_id}/roles/{role_id}
operationId: update-project-role
Updates an existing project role.
See OpenAPI::Client::OpenAI::Path::projects-project_id-roles-role_id.
update_project_service_account
POST /organization/projects/{project_id}/service_accounts/{service_account_id}
operationId: update-project-service-account
Updates a service account in the project.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts-service_account_id.
update_project_spend_alert
POST /organization/projects/{project_id}/spend_alerts/{alert_id}
operationId: update-project-spend-alert
Updates a project spend alert.
See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-spend_alerts-alert_id.
update_role
POST /organization/roles/{role_id}
operationId: update-role
Updates an existing organization role.
See OpenAPI::Client::OpenAI::Path::organization-roles-role_id.
update_skill_default_version
POST /skills/{skill_id}
operationId: UpdateSkillDefaultVersion
Update the default version pointer for a skill.
See OpenAPI::Client::OpenAI::Path::skills-skill_id.
update_vector_store_file_attributes
POST /vector_stores/{vector_store_id}/files/{file_id}
operationId: updateVectorStoreFileAttributes
Update attributes on a vector store file.
See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files-file_id.
update_voice_consent
POST /audio/voice_consents/{consent_id}
operationId: updateVoiceConsent
Updates a voice consent recording (metadata only).
See OpenAPI::Client::OpenAI::Path::audio-voice_consents-consent_id.
upload_certificate
POST /organization/certificates
operationId: uploadCertificate
Upload a certificate to the organization. This does not automatically activate the certificate.
Organizations can upload up to 50 certificates.
See OpenAPI::Client::OpenAI::Path::organization-certificates.
usage_audio_speeches
GET /organization/usage/audio_speeches
operationId: usage-audio-speeches
Get audio speeches usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-audio_speeches.
usage_audio_transcriptions
GET /organization/usage/audio_transcriptions
operationId: usage-audio-transcriptions
Get audio transcriptions usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-audio_transcriptions.
usage_code_interpreter_sessions
GET /organization/usage/code_interpreter_sessions
operationId: usage-code-interpreter-sessions
Get code interpreter sessions usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-code_interpreter_sessions.
usage_completions
GET /organization/usage/completions
operationId: usage-completions
Get completions usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-completions.
usage_costs
GET /organization/costs
operationId: usage-costs
Get costs details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-costs.
usage_embeddings
GET /organization/usage/embeddings
operationId: usage-embeddings
Get embeddings usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-embeddings.
usage_file_search_calls
GET /organization/usage/file_search_calls
operationId: usage-file-search-calls
Get file search calls usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-file_search_calls.
usage_images
GET /organization/usage/images
operationId: usage-images
Get images usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-images.
usage_moderations
GET /organization/usage/moderations
operationId: usage-moderations
Get moderations usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-moderations.
usage_vector_stores
GET /organization/usage/vector_stores
operationId: usage-vector-stores
Get vector stores usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-vector_stores.
usage_web_search_calls
GET /organization/usage/web_search_calls
operationId: usage-web-search-calls
Get web search calls usage details for the organization.
See OpenAPI::Client::OpenAI::Path::organization-usage-web_search_calls.
validate_grader
POST /fine_tuning/alpha/graders/validate
operationId: validateGrader
Validate a grader.
See OpenAPI::Client::OpenAI::Path::fine_tuning-alpha-graders-validate.
COPYRIGHT AND LICENSE
Copyright (C) 2023-2026 by Nelson Ferraz
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.