/ 
OpenAPI-Client-OpenAI-0.27
⭐ Starred 7 / OpenAPI::Client::OpenAI::Path

NAME

OpenAPI::Client::OpenAI::Path - Index of OpenAI API Paths

DESCRIPTION

Index of paths in the OpenAI API; each links to its per-path documentation.

PATHS

/assistants

  • GET list_assistants - Returns a list of assistants.

  • POST create_assistant - Create an assistant with a model and instructions.

See OpenAPI::Client::OpenAI::Path::assistants.

/assistants/{assistant_id}

  • DELETE delete_assistant - Delete an assistant.

  • GET get_assistant - Retrieves an assistant.

  • POST modify_assistant - Modifies an assistant.

See OpenAPI::Client::OpenAI::Path::assistants-assistant_id.

/audio/speech

  • POST create_speech - Generates audio from the input text.

    Returns the audio file content, or a stream of audio events.

See OpenAPI::Client::OpenAI::Path::audio-speech.

/audio/transcriptions

  • POST create_transcription - 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.

/audio/translations

  • POST create_translation - Translates audio into English.

See OpenAPI::Client::OpenAI::Path::audio-translations.

/audio/voice_consents

  • GET list_voice_consents - Returns a list of voice consent recordings.

  • POST create_voice_consent - Upload a voice consent recording.

See OpenAPI::Client::OpenAI::Path::audio-voice_consents.

/audio/voice_consents/{consent_id}

  • DELETE delete_voice_consent - Deletes a voice consent recording.

  • GET get_voice_consent - Retrieves a voice consent recording.

  • POST update_voice_consent - Updates a voice consent recording (metadata only).

See OpenAPI::Client::OpenAI::Path::audio-voice_consents-consent_id.

/audio/voices

  • POST create_voice - Creates a custom voice.

See OpenAPI::Client::OpenAI::Path::audio-voices.

/batches

  • GET list_batches - List your organization's batches.

  • POST create_batch - Creates and executes a batch from an uploaded file of requests

See OpenAPI::Client::OpenAI::Path::batches.

/batches/{batch_id}

  • GET retrieve_batch - Retrieves a batch.

See OpenAPI::Client::OpenAI::Path::batches-batch_id.

/batches/{batch_id}/cancel

  • POST cancel_batch - 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.

/chat/completions

  • GET list_chat_completions - List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.

  • POST create_chat_completion - 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.

/chat/completions/{completion_id}

  • DELETE delete_chat_completion - Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.

  • GET get_chat_completion - Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.

  • POST update_chat_completion - 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.

/chat/completions/{completion_id}/messages

  • GET get_chat_completion_messages - 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.

/chatkit/sessions

  • POST create_chat_session_method - Create a ChatKit session.

See OpenAPI::Client::OpenAI::Path::chatkit-sessions.

/chatkit/sessions/{session_id}/cancel

  • POST cancel_chat_session_method - 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.

/chatkit/threads

  • GET list_threads_method - List ChatKit threads with optional pagination and user filters.

See OpenAPI::Client::OpenAI::Path::chatkit-threads.

/chatkit/threads/{thread_id}

  • DELETE delete_thread_method - Delete a ChatKit thread along with its items and stored attachments.

  • GET get_thread_method - Retrieve a ChatKit thread by its identifier.

See OpenAPI::Client::OpenAI::Path::chatkit-threads-thread_id.

/chatkit/threads/{thread_id}/items

  • GET list_thread_items_method - List items that belong to a ChatKit thread.

See OpenAPI::Client::OpenAI::Path::chatkit-threads-thread_id-items.

/completions

  • POST create_completion - 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.

/containers

  • GET list_containers - List Containers

  • POST create_container - Create Container

See OpenAPI::Client::OpenAI::Path::containers.

/containers/{container_id}

  • DELETE delete_container - Delete Container

  • GET retrieve_container - Retrieve Container

See OpenAPI::Client::OpenAI::Path::containers-container_id.

/containers/{container_id}/files

  • GET list_container_files - List Container files

  • POST create_container_file - 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.

/containers/{container_id}/files/{file_id}

  • DELETE delete_container_file - Delete Container File

  • GET retrieve_container_file - Retrieve Container File

See OpenAPI::Client::OpenAI::Path::containers-container_id-files-file_id.

/containers/{container_id}/files/{file_id}/content

  • GET retrieve_container_file_content - Retrieve Container File Content

See OpenAPI::Client::OpenAI::Path::containers-container_id-files-file_id-content.

/conversations

  • POST create_conversation - Create a conversation.

See OpenAPI::Client::OpenAI::Path::conversations.

/conversations/{conversation_id}

  • DELETE delete_conversation - Delete a conversation. Items in the conversation will not be deleted.

  • GET get_conversation - Get a conversation

  • POST update_conversation - Update a conversation

See OpenAPI::Client::OpenAI::Path::conversations-conversation_id.

/conversations/{conversation_id}/items

  • GET list_conversation_items - List all items for a conversation with the given ID.

  • POST create_conversation_items - Create items in a conversation with the given ID.

See OpenAPI::Client::OpenAI::Path::conversations-conversation_id-items.

/conversations/{conversation_id}/items/{item_id}

  • DELETE delete_conversation_item - Delete an item from a conversation with the given IDs.

  • GET get_conversation_item - Get a single item from a conversation with the given IDs.

See OpenAPI::Client::OpenAI::Path::conversations-conversation_id-items-item_id.

/embeddings

  • POST create_embedding - Creates an embedding vector representing the input text.

See OpenAPI::Client::OpenAI::Path::embeddings.

/evals

  • GET list_evals - List evaluations for a project.

  • POST create_eval - 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.

/evals/{eval_id}

  • DELETE delete_eval - Delete an evaluation.

  • GET get_eval - Get an evaluation by ID.

  • POST update_eval - Update certain properties of an evaluation.

See OpenAPI::Client::OpenAI::Path::evals-eval_id.

/evals/{eval_id}/runs

  • GET get_eval_runs - Get a list of runs for an evaluation.

  • POST create_eval_run - 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.

/evals/{eval_id}/runs/{run_id}

  • DELETE delete_eval_run - Delete an eval run.

  • GET get_eval_run - Get an evaluation run by ID.

  • POST cancel_eval_run - Cancel an ongoing evaluation run.

See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id.

/evals/{eval_id}/runs/{run_id}/output_items

  • GET get_eval_run_output_items - Get a list of output items for an evaluation run.

See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id-output_items.

/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

  • GET get_eval_run_output_item - Get an evaluation run output item by ID.

See OpenAPI::Client::OpenAI::Path::evals-eval_id-runs-run_id-output_items-output_item_id.

/files

  • GET list_files - Returns a list of files.

  • POST create_file - 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.

/files/{file_id}

  • DELETE delete_file - Delete a file and remove it from all vector stores.

  • GET retrieve_file - Returns information about a specific file.

See OpenAPI::Client::OpenAI::Path::files-file_id.

/files/{file_id}/content

  • GET download_file - Returns the contents of the specified file.

See OpenAPI::Client::OpenAI::Path::files-file_id-content.

/fine_tuning/alpha/graders/run

  • POST run_grader - Run a grader.

See OpenAPI::Client::OpenAI::Path::fine_tuning-alpha-graders-run.

/fine_tuning/alpha/graders/validate

  • POST validate_grader - Validate a grader.

See OpenAPI::Client::OpenAI::Path::fine_tuning-alpha-graders-validate.

/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions

  • GET list_fine_tuning_checkpoint_permissions - NOTE: This endpoint requires an admin API key .

    Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.

  • POST create_fine_tuning_checkpoint_permission - 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.

/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}

  • DELETE delete_fine_tuning_checkpoint_permission - NOTE: This endpoint requires an admin API key .

    Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.

See OpenAPI::Client::OpenAI::Path::fine_tuning-checkpoints-fine_tuned_model_checkpoint-permissions-permission_id.

/fine_tuning/jobs

  • GET list_paginated_fine_tuning_jobs - List your organization's fine-tuning jobs

  • POST create_fine_tuning_job - 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.

    Learn more about fine-tuning

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs.

/fine_tuning/jobs/{fine_tuning_job_id}

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id.

/fine_tuning/jobs/{fine_tuning_job_id}/cancel

  • POST cancel_fine_tuning_job - Immediately cancel a fine-tune job.

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-cancel.

/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

  • GET list_fine_tuning_job_checkpoints - List checkpoints for a fine-tuning job.

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-checkpoints.

/fine_tuning/jobs/{fine_tuning_job_id}/events

  • GET list_fine_tuning_events - Get status updates for a fine-tuning job.

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-events.

/fine_tuning/jobs/{fine_tuning_job_id}/pause

  • POST pause_fine_tuning_job - Pause a fine-tune job.

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-pause.

/fine_tuning/jobs/{fine_tuning_job_id}/resume

  • POST resume_fine_tuning_job - Resume a fine-tune job.

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id-resume.

/images/edits

  • POST create_image_edit - 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.

/images/generations

  • POST create_image - Creates an image given a prompt. Learn more .

See OpenAPI::Client::OpenAI::Path::images-generations.

/images/variations

  • POST create_image_variation - Creates a variation of a given image. This endpoint only supports dall-e-2 .

See OpenAPI::Client::OpenAI::Path::images-variations.

/models

  • GET list_models - Lists the currently available models, and provides basic information about each one such as the owner and availability.

See OpenAPI::Client::OpenAI::Path::models.

/models/{model}

  • DELETE delete_model - Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.

  • GET retrieve_model - Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

See OpenAPI::Client::OpenAI::Path::models-model.

/moderations

  • POST create_moderation - Classifies if text and/or image inputs are potentially harmful. Learn more in the moderation guide .

See OpenAPI::Client::OpenAI::Path::moderations.

/organization/admin_api_keys

  • GET admin_api_keys_list - List organization API keys

  • POST admin_api_keys_create - Create an organization admin API key

See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys.

/organization/admin_api_keys/{key_id}

  • DELETE admin_api_keys_delete - Delete an organization admin API key

  • GET admin_api_keys_get - Retrieve a single organization API key

See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys-key_id.

/organization/audit_logs

  • GET list_audit_logs - List user actions and configuration changes within this organization.

See OpenAPI::Client::OpenAI::Path::organization-audit_logs.

/organization/certificates

  • GET list_organization_certificates - List uploaded certificates for this organization.

  • POST upload_certificate - 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.

/organization/certificates/activate

  • POST activate_organization_certificates - 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.

/organization/certificates/deactivate

  • POST deactivate_organization_certificates - 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.

/organization/certificates/{certificate_id}

  • DELETE delete_certificate - Delete a certificate from the organization.

    The certificate must be inactive for the organization and all projects.

  • GET get_certificate - Get a certificate that has been uploaded to the organization.

    You can get a certificate regardless of whether it is active or not.

  • POST modify_certificate - Modify a certificate. Note that only the name can be modified.

See OpenAPI::Client::OpenAI::Path::organization-certificates-certificate_id.

/organization/costs

  • GET usage_costs - Get costs details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-costs.

/organization/data_retention

  • GET retrieve_organization_data_retention - Retrieves organization data retention controls.

  • POST update_organization_data_retention - Updates organization data retention controls.

See OpenAPI::Client::OpenAI::Path::organization-data_retention.

/organization/groups

  • GET list_groups - Lists all groups in the organization.

  • POST create_group - Creates a new group in the organization.

See OpenAPI::Client::OpenAI::Path::organization-groups.

/organization/groups/{group_id}

  • DELETE delete_group - Deletes a group from the organization.

  • GET retrieve_group - Retrieves a group.

  • POST update_group - Updates a group's information.

See OpenAPI::Client::OpenAI::Path::organization-groups-group_id.

/organization/groups/{group_id}/roles

  • GET list_group_role_assignments - Lists the organization roles assigned to a group within the organization.

  • POST assign_group_role - Assigns an organization role to a group within the organization.

See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-roles.

/organization/groups/{group_id}/roles/{role_id}

  • DELETE unassign_group_role - Unassigns an organization role from a group within the organization.

  • GET retrieve_group_role - Retrieves an organization role assigned to a group.

See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-roles-role_id.

/organization/groups/{group_id}/users

  • GET list_group_users - Lists the users assigned to a group.

  • POST add_group_user - Adds a user to a group.

See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-users.

/organization/groups/{group_id}/users/{user_id}

  • DELETE remove_group_user - Removes a user from a group.

  • GET retrieve_group_user - Retrieves a user in a group.

See OpenAPI::Client::OpenAI::Path::organization-groups-group_id-users-user_id.

/organization/invites

  • GET list_invites - Returns a list of invites in the organization.

  • POST invite_user - 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.

/organization/invites/{invite_id}

  • DELETE delete_invite - Delete an invite. If the invite has already been accepted, it cannot be deleted.

  • GET retrieve_invite - Retrieves an invite.

See OpenAPI::Client::OpenAI::Path::organization-invites-invite_id.

/organization/projects

  • GET list_projects - Returns a list of projects.

  • POST 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.

/organization/projects/{project_id}

  • GET retrieve_project - Retrieves a project.

  • POST modify_project - Modifies a project in the organization.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id.

/organization/projects/{project_id}/api_keys

  • GET list_project_api_keys - Returns a list of API keys in the project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-api_keys.

/organization/projects/{project_id}/api_keys/{api_key_id}

  • DELETE 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.

  • GET 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.

/organization/projects/{project_id}/archive

  • POST 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.

/organization/projects/{project_id}/certificates

  • GET list_project_certificates - List certificates for this project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-certificates.

/organization/projects/{project_id}/certificates/activate

  • POST activate_project_certificates - 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.

/organization/projects/{project_id}/certificates/deactivate

  • POST deactivate_project_certificates - 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.

/organization/projects/{project_id}/data_retention

  • GET retrieve_project_data_retention - Retrieves project data retention controls.

  • POST update_project_data_retention - Updates project data retention controls.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-data_retention.

/organization/projects/{project_id}/groups

  • GET list_project_groups - Lists the groups that have access to a project.

  • POST add_project_group - Grants a group access to a project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-groups.

/organization/projects/{project_id}/groups/{group_id}

  • DELETE remove_project_group - Revokes a group's access to a project.

  • GET retrieve_project_group - Retrieves a project's group.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-groups-group_id.

/organization/projects/{project_id}/hosted_tool_permissions

  • GET retrieve_project_hosted_tool_permissions - Returns hosted tool permissions for a project.

  • POST update_project_hosted_tool_permissions - Updates hosted tool permissions for a project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-hosted_tool_permissions.

/organization/projects/{project_id}/model_permissions

  • DELETE delete_project_model_permissions - Deletes model permissions for a project.

  • GET retrieve_project_model_permissions - Returns model permissions for a project.

  • POST update_project_model_permissions - Updates model permissions for a project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-model_permissions.

/organization/projects/{project_id}/rate_limits

  • GET list_project_rate_limits - Returns the rate limits per model for a project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-rate_limits.

/organization/projects/{project_id}/rate_limits/{rate_limit_id}

  • POST update_project_rate_limits - Updates a project rate limit.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-rate_limits-rate_limit_id.

/organization/projects/{project_id}/service_accounts

  • GET list_project_service_accounts - Returns a list of service accounts in the project.

  • POST 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.

/organization/projects/{project_id}/service_accounts/{service_account_id}

  • DELETE 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).

  • GET retrieve_project_service_account - Retrieves a service account in the project.

  • POST 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.

/organization/projects/{project_id}/spend_alerts

  • GET list_project_spend_alerts - Lists project spend alerts.

  • POST create_project_spend_alert - Creates a project spend alert.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-spend_alerts.

/organization/projects/{project_id}/spend_alerts/{alert_id}

  • DELETE delete_project_spend_alert - Deletes a project spend alert.

  • POST update_project_spend_alert - Updates a project spend alert.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-spend_alerts-alert_id.

/organization/projects/{project_id}/users

  • GET list_project_users - Returns a list of users in the project.

  • POST 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.

/organization/projects/{project_id}/users/{user_id}

  • DELETE 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).

  • GET retrieve_project_user - Retrieves a user in the project.

  • POST modify_project_user - Modifies a user's role in the project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users-user_id.

/organization/roles

  • GET list_roles - Lists the roles configured for the organization.

  • POST create_role - Creates a custom role for the organization.

See OpenAPI::Client::OpenAI::Path::organization-roles.

/organization/roles/{role_id}

  • DELETE delete_role - Deletes a custom role from the organization.

  • GET retrieve_role - Retrieves an organization role.

  • POST update_role - Updates an existing organization role.

See OpenAPI::Client::OpenAI::Path::organization-roles-role_id.

/organization/spend_alerts

  • GET list_organization_spend_alerts - Lists organization spend alerts.

  • POST create_organization_spend_alert - Creates an organization spend alert.

See OpenAPI::Client::OpenAI::Path::organization-spend_alerts.

/organization/spend_alerts/{alert_id}

  • DELETE delete_organization_spend_alert - Deletes an organization spend alert.

  • POST update_organization_spend_alert - Updates an organization spend alert.

See OpenAPI::Client::OpenAI::Path::organization-spend_alerts-alert_id.

/organization/usage/audio_speeches

  • GET usage_audio_speeches - Get audio speeches usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-audio_speeches.

/organization/usage/audio_transcriptions

  • GET usage_audio_transcriptions - Get audio transcriptions usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-audio_transcriptions.

/organization/usage/code_interpreter_sessions

  • GET usage_code_interpreter_sessions - Get code interpreter sessions usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-code_interpreter_sessions.

/organization/usage/completions

  • GET usage_completions - Get completions usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-completions.

/organization/usage/embeddings

  • GET usage_embeddings - Get embeddings usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-embeddings.

/organization/usage/file_search_calls

  • GET usage_file_search_calls - Get file search calls usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-file_search_calls.

/organization/usage/images

  • GET usage_images - Get images usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-images.

/organization/usage/moderations

  • GET usage_moderations - Get moderations usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-moderations.

/organization/usage/vector_stores

  • GET usage_vector_stores - Get vector stores usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-vector_stores.

/organization/usage/web_search_calls

  • GET usage_web_search_calls - Get web search calls usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-web_search_calls.

/organization/users

  • GET list_users - Lists all of the users in the organization.

See OpenAPI::Client::OpenAI::Path::organization-users.

/organization/users/{user_id}

  • DELETE delete_user - Deletes a user from the organization.

  • GET retrieve_user - Retrieves a user by their identifier.

  • POST modify_user - Modifies a user's role in the organization.

See OpenAPI::Client::OpenAI::Path::organization-users-user_id.

/organization/users/{user_id}/roles

  • GET list_user_role_assignments - Lists the organization roles assigned to a user within the organization.

  • POST assign_user_role - Assigns an organization role to a user within the organization.

See OpenAPI::Client::OpenAI::Path::organization-users-user_id-roles.

/organization/users/{user_id}/roles/{role_id}

  • DELETE unassign_user_role - Unassigns an organization role from a user within the organization.

  • GET retrieve_user_role - Retrieves an organization role assigned to a user.

See OpenAPI::Client::OpenAI::Path::organization-users-user_id-roles-role_id.

/projects/{project_id}/groups/{group_id}/roles

  • GET list_project_group_role_assignments - Lists the project roles assigned to a group within a project.

  • POST 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.

/projects/{project_id}/groups/{group_id}/roles/{role_id}

  • DELETE unassign_project_group_role - Unassigns a project role from a group within a project.

  • GET 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.

/projects/{project_id}/roles

  • GET list_project_roles - Lists the roles configured for a project.

  • POST create_project_role - Creates a custom role for a project.

See OpenAPI::Client::OpenAI::Path::projects-project_id-roles.

/projects/{project_id}/roles/{role_id}

  • DELETE delete_project_role - Deletes a custom role from a project.

  • GET retrieve_project_role - Retrieves a project role.

  • POST update_project_role - Updates an existing project role.

See OpenAPI::Client::OpenAI::Path::projects-project_id-roles-role_id.

/projects/{project_id}/users/{user_id}/roles

  • GET list_project_user_role_assignments - Lists the project roles assigned to a user within a project.

  • POST 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.

/projects/{project_id}/users/{user_id}/roles/{role_id}

  • DELETE unassign_project_user_role - Unassigns a project role from a user within a project.

  • GET 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.

/realtime/calls

  • POST 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.

/realtime/calls/{call_id}/accept

  • POST 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.

/realtime/calls/{call_id}/hangup

  • POST 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.

/realtime/calls/{call_id}/refer

  • POST 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.

/realtime/calls/{call_id}/reject

  • POST 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.

/realtime/client_secrets

  • POST 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.

/realtime/sessions

  • POST 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.

/realtime/transcription_sessions

  • POST 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.

/realtime/translations/client_secrets

  • POST 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.

/responses

See OpenAPI::Client::OpenAI::Path::responses.

/responses/compact

  • POST 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.

/responses/input_tokens

  • POST 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.

/responses/{response_id}

  • DELETE delete_response - Deletes a model response with the given ID.

  • GET get_response - Retrieves a model response with the given ID.

See OpenAPI::Client::OpenAI::Path::responses-response_id.

/responses/{response_id}/cancel

  • POST cancel_response - 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.

/responses/{response_id}/input_items

  • GET list_input_items - Returns a list of input items for a given response.

See OpenAPI::Client::OpenAI::Path::responses-response_id-input_items.

/skills

  • GET list_skills - List all skills for the current project.

  • POST create_skill - Create a new skill.

See OpenAPI::Client::OpenAI::Path::skills.

/skills/{skill_id}

  • DELETE delete_skill - Delete a skill by its ID.

  • GET get_skill - Get a skill by its ID.

  • POST update_skill_default_version - Update the default version pointer for a skill.

See OpenAPI::Client::OpenAI::Path::skills-skill_id.

/skills/{skill_id}/content

  • GET get_skill_content - Download a skill zip bundle by its ID.

See OpenAPI::Client::OpenAI::Path::skills-skill_id-content.

/skills/{skill_id}/versions

  • GET list_skill_versions - List skill versions for a skill.

  • POST create_skill_version - Create a new immutable skill version.

See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions.

/skills/{skill_id}/versions/{version}

  • DELETE delete_skill_version - Delete a skill version.

  • GET get_skill_version - Get a specific skill version.

See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions-version.

/skills/{skill_id}/versions/{version}/content

  • GET get_skill_version_content - Download a skill version zip bundle.

See OpenAPI::Client::OpenAI::Path::skills-skill_id-versions-version-content.

/threads

  • POST create_thread - Create a thread.

See OpenAPI::Client::OpenAI::Path::threads.

/threads/runs

  • POST create_thread_and_run - Create a thread and run it in one request.

See OpenAPI::Client::OpenAI::Path::threads-runs.

/threads/{thread_id}

  • DELETE delete_thread - Delete a thread.

  • GET get_thread - Retrieves a thread.

  • POST modify_thread - Modifies a thread.

See OpenAPI::Client::OpenAI::Path::threads-thread_id.

/threads/{thread_id}/messages

  • GET list_messages - Returns a list of messages for a given thread.

  • POST create_message - Create a message.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages.

/threads/{thread_id}/messages/{message_id}

  • DELETE delete_message - Deletes a message.

  • GET get_message - Retrieve a message.

  • POST modify_message - Modifies a message.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages-message_id.

/threads/{thread_id}/runs

  • GET list_runs - Returns a list of runs belonging to a thread.

  • POST create_run - Create a run.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs.

/threads/{thread_id}/runs/{run_id}

  • GET get_run - Retrieves a run.

  • POST modify_run - Modifies a run.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id.

/threads/{thread_id}/runs/{run_id}/cancel

  • POST cancel_run - Cancels a run that is in_progress .

See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-cancel.

/threads/{thread_id}/runs/{run_id}/steps

  • GET list_run_steps - Returns a list of run steps belonging to a run.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-steps.

/threads/{thread_id}/runs/{run_id}/steps/{step_id}

  • GET get_run_step - Retrieves a run step.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-steps-step_id.

/threads/{thread_id}/runs/{run_id}/submit_tool_outputs

  • POST submit_tool_ouputs_to_run - 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.

/uploads

  • POST create_upload - 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.

/uploads/{upload_id}/cancel

  • POST cancel_upload - 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.

/uploads/{upload_id}/complete

  • POST complete_upload - 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.

/uploads/{upload_id}/parts

  • POST add_upload_part - 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.

/vector_stores

  • GET list_vector_stores - Returns a list of vector stores.

  • POST create_vector_store - Create a vector store.

See OpenAPI::Client::OpenAI::Path::vector_stores.

/vector_stores/{vector_store_id}

  • DELETE delete_vector_store - Delete a vector store.

  • GET get_vector_store - Retrieves a vector store.

  • POST modify_vector_store - Modifies a vector store.

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id.

/vector_stores/{vector_store_id}/file_batches

  • POST create_vector_store_file_batch - Create a vector store file batch.

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches.

/vector_stores/{vector_store_id}/file_batches/{batch_id}

  • GET get_vector_store_file_batch - Retrieves a vector store file batch.

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id.

/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

  • POST cancel_vector_store_file_batch - 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.

/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

  • GET list_files_in_vector_store_batch - 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.

/vector_stores/{vector_store_id}/files

  • GET list_vector_store_files - Returns a list of vector store files.

  • POST create_vector_store_file - Create a vector store file by attaching a File to a vector store .

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files.

/vector_stores/{vector_store_id}/files/{file_id}

  • DELETE delete_vector_store_file - 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.

  • GET get_vector_store_file - Retrieves a vector store file.

  • POST update_vector_store_file_attributes - Update attributes on a vector store file.

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files-file_id.

/vector_stores/{vector_store_id}/files/{file_id}/content

  • GET retrieve_vector_store_file_content - Retrieve the parsed contents of a vector store file.

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files-file_id-content.

/vector_stores/{vector_store_id}/search

  • POST search_vector_store - 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.

/videos

  • GET list_videos - List recently generated videos for the current project.

  • POST create_video - Create a new video generation job from a prompt and optional reference assets.

See OpenAPI::Client::OpenAI::Path::videos.

/videos/characters

  • POST create_video_character - Create a character from an uploaded video.

See OpenAPI::Client::OpenAI::Path::videos-characters.

/videos/characters/{character_id}

  • GET get_video_character - Fetch a character.

See OpenAPI::Client::OpenAI::Path::videos-characters-character_id.

/videos/edits

  • POST create_video_edit - Create a new video generation job by editing a source video or existing generated video.

See OpenAPI::Client::OpenAI::Path::videos-edits.

/videos/extensions

  • POST create_video_extend - Create an extension of a completed video.

See OpenAPI::Client::OpenAI::Path::videos-extensions.

/videos/{video_id}

  • DELETE delete_video - Permanently delete a completed or failed video and its stored assets.

  • GET get_video - Fetch the latest metadata for a generated video.

See OpenAPI::Client::OpenAI::Path::videos-video_id.

/videos/{video_id}/content

  • GET retrieve_video_content - 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.

/videos/{video_id}/remix

  • POST create_video_remix - Create a remix of a completed video using a refreshed prompt.

See OpenAPI::Client::OpenAI::Path::videos-video_id-remix.

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.