/ 
OpenAPI-Client-OpenAI-0.21
River stage zero No dependents
/ OpenAPI::Client::OpenAI::Path

NAME

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

DESCRIPTION

This document provides an index of the available paths in the OpenAI API, along with the supported HTTP methods and their summaries. For detailed information about each path and its usage, please refer to the linked POD files.

PATHS

/assistants

  • GET - Returns a list of assistants.

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

See OpenAPI::Client::OpenAI::Path::assistants for more details.

/assistants/{assistant_id}

  • DELETE - Delete an assistant.

  • GET - Retrieves an assistant.

  • POST - Modifies an assistant.

See OpenAPI::Client::OpenAI::Path::assistants-assistant_id for more details.

/audio/speech

  • POST - Generates audio from the input text.

See OpenAPI::Client::OpenAI::Path::audio-speech for more details.

/audio/transcriptions

  • POST - Transcribes audio into the input language.

See OpenAPI::Client::OpenAI::Path::audio-transcriptions for more details.

/audio/translations

  • POST - Translates audio into English.

See OpenAPI::Client::OpenAI::Path::audio-translations for more details.

/batches

  • GET - List your organization's batches.

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

See OpenAPI::Client::OpenAI::Path::batches for more details.

/batches/{batch_id}

  • GET - Retrieves a batch.

See OpenAPI::Client::OpenAI::Path::batches-batch_id for more details.

/batches/{batch_id}/cancel

  • POST - 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 for more details.

/chat/completions

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

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

See OpenAPI::Client::OpenAI::Path::chat-completions for more details.

/chat/completions/{completion_id}

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

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

  • POST - 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 for more details.

/chat/completions/{completion_id}/messages

  • GET - 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 for more details.

/completions

  • POST - Creates a completion for the provided prompt and parameters.

See OpenAPI::Client::OpenAI::Path::completions for more details.

/embeddings

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

See OpenAPI::Client::OpenAI::Path::embeddings for more details.

/files

  • GET - Returns a list of files.

  • POST - Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB.

    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.

    Please contact us if you need to increase these storage limits.

See OpenAPI::Client::OpenAI::Path::files for more details.

/files/{file_id}

  • DELETE - Delete a file.

  • GET - Returns information about a specific file.

See OpenAPI::Client::OpenAI::Path::files-file_id for more details.

/files/{file_id}/content

  • GET - Returns the contents of the specified file.

See OpenAPI::Client::OpenAI::Path::files-file_id-content for more details.

/fine_tuning/checkpoints/{permission_id}/permissions

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

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

  • GET - 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 - 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-permission_id-permissions for more details.

/fine_tuning/jobs

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

  • POST - 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 for more details.

/fine_tuning/jobs/{fine_tuning_job_id}

See OpenAPI::Client::OpenAI::Path::fine_tuning-jobs-fine_tuning_job_id for more details.

/fine_tuning/jobs/{fine_tuning_job_id}/cancel

  • POST - Immediately cancel a fine-tune job.

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

/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

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

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

/fine_tuning/jobs/{fine_tuning_job_id}/events

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

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

/images/edits

  • POST - Creates an edited or extended image given an original image and a prompt.

See OpenAPI::Client::OpenAI::Path::images-edits for more details.

/images/generations

  • POST - Creates an image given a prompt.

See OpenAPI::Client::OpenAI::Path::images-generations for more details.

/images/variations

  • POST - Creates a variation of a given image.

See OpenAPI::Client::OpenAI::Path::images-variations for more details.

/models

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

See OpenAPI::Client::OpenAI::Path::models for more details.

/models/{model}

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

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

See OpenAPI::Client::OpenAI::Path::models-model for more details.

/moderations

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

See OpenAPI::Client::OpenAI::Path::moderations for more details.

/organization/admin_api_keys

  • GET - List organization API keys

  • POST - Create an organization admin API key

See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys for more details.

/organization/admin_api_keys/{key_id}

  • DELETE - Delete an organization admin API key

  • GET - Retrieve a single organization API key

See OpenAPI::Client::OpenAI::Path::organization-admin_api_keys-key_id for more details.

/organization/audit_logs

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

See OpenAPI::Client::OpenAI::Path::organization-audit_logs for more details.

/organization/costs

  • GET - Get costs details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-costs for more details.

/organization/invites

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

  • POST - 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 for more details.

/organization/invites/{invite_id}

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

  • GET - Retrieves an invite.

See OpenAPI::Client::OpenAI::Path::organization-invites-invite_id for more details.

/organization/projects

  • GET - Returns a list of projects.

  • POST - Create a new project in the organization. Projects can be created and archived, but cannot be deleted.

See OpenAPI::Client::OpenAI::Path::organization-projects for more details.

/organization/projects/{project_id}

  • GET - Retrieves a project.

  • POST - Modifies a project in the organization.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id for more details.

/organization/projects/{project_id}/api_keys

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

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

/organization/projects/{project_id}/api_keys/{key_id}

  • DELETE - Deletes an API key from the project.

  • GET - Retrieves an API key in the project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-api_keys-key_id for more details.

/organization/projects/{project_id}/archive

  • POST - Archives a project in the organization. Archived projects cannot be used or updated.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-archive for more details.

/organization/projects/{project_id}/rate_limits

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

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

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

  • POST - Updates a project rate limit.

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

/organization/projects/{project_id}/service_accounts

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

  • POST - 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 for more details.

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

  • DELETE - Deletes a service account from the project.

  • GET - Retrieves a service account in the project.

See OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts-service_account_id for more details.

/organization/projects/{project_id}/users

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

  • POST - 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 for more details.

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

  • DELETE - Deletes a user from the project.

  • GET - Retrieves a user in the project.

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

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

/organization/usage/audio_speeches

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

See OpenAPI::Client::OpenAI::Path::organization-usage-audio_speeches for more details.

/organization/usage/audio_transcriptions

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

See OpenAPI::Client::OpenAI::Path::organization-usage-audio_transcriptions for more details.

/organization/usage/code_interpreter_sessions

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

See OpenAPI::Client::OpenAI::Path::organization-usage-code_interpreter_sessions for more details.

/organization/usage/completions

  • GET - Get completions usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-completions for more details.

/organization/usage/embeddings

  • GET - Get embeddings usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-embeddings for more details.

/organization/usage/images

  • GET - Get images usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-images for more details.

/organization/usage/moderations

  • GET - Get moderations usage details for the organization.

See OpenAPI::Client::OpenAI::Path::organization-usage-moderations for more details.

/organization/usage/vector_stores

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

See OpenAPI::Client::OpenAI::Path::organization-usage-vector_stores for more details.

/organization/users

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

See OpenAPI::Client::OpenAI::Path::organization-users for more details.

/organization/users/{user_id}

  • DELETE - Deletes a user from the organization.

  • GET - Retrieves a user by their identifier.

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

See OpenAPI::Client::OpenAI::Path::organization-users-user_id for more details.

/realtime/sessions

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

See OpenAPI::Client::OpenAI::Path::realtime-sessions for more details.

/realtime/transcription_sessions

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

See OpenAPI::Client::OpenAI::Path::realtime-transcription_sessions for more details.

/responses

See OpenAPI::Client::OpenAI::Path::responses for more details.

/responses/{response_id}

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

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

See OpenAPI::Client::OpenAI::Path::responses-response_id for more details.

/responses/{response_id}/input_items

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

See OpenAPI::Client::OpenAI::Path::responses-response_id-input_items for more details.

/threads

  • POST - Create a thread.

See OpenAPI::Client::OpenAI::Path::threads for more details.

/threads/runs

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

See OpenAPI::Client::OpenAI::Path::threads-runs for more details.

/threads/{thread_id}

  • DELETE - Delete a thread.

  • GET - Retrieves a thread.

  • POST - Modifies a thread.

See OpenAPI::Client::OpenAI::Path::threads-thread_id for more details.

/threads/{thread_id}/messages

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

  • POST - Create a message.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-messages for more details.

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

  • DELETE - Deletes a message.

  • GET - Retrieve a message.

  • POST - Modifies a message.

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

/threads/{thread_id}/runs

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

  • POST - Create a run.

See OpenAPI::Client::OpenAI::Path::threads-thread_id-runs for more details.

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

  • GET - Retrieves a run.

  • POST - Modifies a run.

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

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

  • POST - Cancels a run that is in_progress.

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

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

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

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

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

  • GET - Retrieves a run step.

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

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

  • POST - 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 for more details.

/uploads

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

See OpenAPI::Client::OpenAI::Path::uploads for more details.

/uploads/{upload_id}/cancel

  • POST - Cancels the Upload. No Parts may be added after an Upload is cancelled.

See OpenAPI::Client::OpenAI::Path::uploads-upload_id-cancel for more details.

/uploads/{upload_id}/complete

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

See OpenAPI::Client::OpenAI::Path::uploads-upload_id-complete for more details.

/uploads/{upload_id}/parts

  • POST - 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 for more details.

/vector_stores

  • GET - Returns a list of vector stores.

  • POST - Create a vector store.

See OpenAPI::Client::OpenAI::Path::vector_stores for more details.

/vector_stores/{vector_store_id}

  • DELETE - Delete a vector store.

  • GET - Retrieves a vector store.

  • POST - Modifies a vector store.

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id for more details.

/vector_stores/{vector_store_id}/file_batches

  • POST - Create a vector store file batch.

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches for more details.

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

  • GET - Retrieves a vector store file batch.

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

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

  • POST - 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 for more details.

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

  • GET - 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 for more details.

/vector_stores/{vector_store_id}/files

  • GET - Returns a list of vector store files.

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

See OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-files for more details.

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

  • DELETE - 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 - Retrieves a vector store file.

  • POST - Update attributes on a vector store file.

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

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

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

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

/vector_stores/{vector_store_id}/search

  • POST - 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 for more details.

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 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.