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 - List assistants
POST - Create assistant

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

`/assistants/{assistant_id}`

DELETE - Delete assistant
GET - Retrieve assistant
POST - Modify assistant

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

`/audio/speech`

POST - Create speech

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

`/audio/transcriptions`

POST - Create transcription

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

`/audio/translations`

POST - Create translation

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

`/batches`

GET - List batch
POST - Create batch

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

`/batches/{batch_id}`

GET - Retrieve batch

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

`/batches/{batch_id}/cancel`

POST - Cancel batch

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

`/chat/completions`

GET - List Chat Completions
POST - Create chat completion

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

`/chat/completions/{completion_id}`

DELETE - Delete chat completion
GET - Get chat completion
POST - Update chat completion

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

`/chat/completions/{completion_id}/messages`

GET - Get chat messages

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

`/completions`

POST - Create completion

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

`/containers`

GET - List containers
POST - Create container

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

`/containers/{container_id}`

DELETE - Delete a container
GET - Retrieve container

See OpenAPI::Client::OpenAI::Path::containers-container_id for more details.

`/containers/{container_id}/files`

GET - List container files
POST - Create container file

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

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

DELETE - Delete a container file
GET - Retrieve container file

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

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

GET - Retrieve container file content

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

`/conversations`

POST - Create a conversation

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

`/conversations/{conversation_id}`

DELETE - Delete a conversation
GET - Retrieve a conversation
POST - Update a conversation

See OpenAPI::Client::OpenAI::Path::conversations-conversation_id for more details.

`/conversations/{conversation_id}/items`

GET - List items
POST - Create items

See OpenAPI::Client::OpenAI::Path::conversations-conversation_id-items for more details.

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

DELETE - Delete an item
GET - Retrieve an item

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

`/embeddings`

POST - Create embeddings

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

`/evals`

GET - List evals
POST - Create eval

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

`/evals/{eval_id}`

DELETE - Delete an eval
GET - Get an eval
POST - Update an eval

See OpenAPI::Client::OpenAI::Path::evals-eval_id for more details.

`/evals/{eval_id}/runs`

GET - Get eval runs
POST - Create eval run

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

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

DELETE - Delete eval run
GET - Get an eval run
POST - Cancel eval run

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

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

GET - Get eval run output items

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

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

GET - Get an output item of an eval run

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

`/files`

GET - List files
POST - Upload file

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

`/files/{file_id}`

DELETE - Delete file
GET - Retrieve file

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

`/files/{file_id}/content`

GET - Retrieve file content

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

`/fine_tuning/alpha/graders/run`

POST - Run grader

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

`/fine_tuning/alpha/graders/validate`

POST - Validate grader

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

`/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`

GET - List checkpoint permissions
POST - Create checkpoint permissions

See OpenAPI::Client::OpenAI::Path::fine_tuning-checkpoints-fine_tuned_model_checkpoint-permissions for more details.

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

DELETE - Delete checkpoint permission

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

`/fine_tuning/jobs`

GET - List fine-tuning jobs
POST - Create fine-tuning job

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

`/fine_tuning/jobs/{fine_tuning_job_id}`

GET - Retrieve fine-tuning job

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

`/fine_tuning/jobs/{fine_tuning_job_id}/cancel`

POST - Cancel fine-tuning

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 fine-tuning checkpoints

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 - List fine-tuning events

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

`/fine_tuning/jobs/{fine_tuning_job_id}/pause`

POST - Pause fine-tuning

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

`/fine_tuning/jobs/{fine_tuning_job_id}/resume`

POST - Resume fine-tuning

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

`/images/edits`

POST - Create image edit

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

`/images/generations`

POST - Create image

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

`/images/variations`

POST - Create image variation

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

`/models`

GET - List models

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

`/models/{model}`

DELETE - Delete a fine-tuned model
GET - Retrieve model

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

`/moderations`

POST - Create moderation

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

`/organization/admin_api_keys`

GET - List all organization and project API keys.
POST - Create admin API key

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

`/organization/admin_api_keys/{key_id}`

DELETE - Delete admin API key
GET - Retrieve admin API key

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

`/organization/audit_logs`

GET - List audit logs

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

`/organization/certificates`

GET - List organization certificates
POST - Upload certificate

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

`/organization/certificates/activate`

POST - Activate certificates for organization

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

`/organization/certificates/deactivate`

POST - Deactivate certificates for organization

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

`/organization/certificates/{certificate_id}`

DELETE - Delete certificate
GET - Get certificate
POST - Modify certificate

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

`/organization/costs`

GET - Costs

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

`/organization/invites`

GET - List invites
POST - Create invite

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

`/organization/invites/{invite_id}`

DELETE - Delete invite
GET - Retrieve invite

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

`/organization/projects`

GET - List projects
POST - Create project

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

`/organization/projects/{project_id}`

GET - Retrieve project
POST - Modify project

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

`/organization/projects/{project_id}/api_keys`

GET - List project API keys

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

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

DELETE - Delete project API key
GET - Retrieve project API key

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

`/organization/projects/{project_id}/archive`

POST - Archive project

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

`/organization/projects/{project_id}/certificates`

GET - List project certificates

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

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

POST - Activate certificates for project

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

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

POST - Deactivate certificates for project

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

`/organization/projects/{project_id}/rate_limits`

GET - List project rate limits

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

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

POST - Modify 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 - List project service accounts
POST - Create project 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 - Delete project service account
GET - Retrieve project service account

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

`/organization/projects/{project_id}/users`

GET - List project users
POST - Create project user

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

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

DELETE - Delete project user
GET - Retrieve project user
POST - Modify project user

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

`/organization/usage/audio_speeches`

GET - Audio speeches

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

`/organization/usage/audio_transcriptions`

GET - Audio transcriptions

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

`/organization/usage/code_interpreter_sessions`

GET - Code interpreter sessions

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

`/organization/usage/completions`

GET - Completions

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

`/organization/usage/embeddings`

GET - Embeddings

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

`/organization/usage/images`

GET - Images

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

`/organization/usage/moderations`

GET - Moderations

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

`/organization/usage/vector_stores`

GET - Vector stores

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

`/organization/users`

GET - List users

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

`/organization/users/{user_id}`

DELETE - Delete user
GET - Retrieve user
POST - Modify user

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

`/realtime/sessions`

POST - Create session

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

`/realtime/transcription_sessions`

POST - Create transcription session

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

`/responses`

POST - Create a model response

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

`/responses/{response_id}`

DELETE - Delete a model response
GET - Get a model response

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

`/responses/{response_id}/cancel`

POST - Cancel a response

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

`/responses/{response_id}/input_items`

GET - List input items

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

`/threads`

POST - Create thread

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

`/threads/runs`

POST - Create thread and run

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

`/threads/{thread_id}`

DELETE - Delete thread
GET - Retrieve thread
POST - Modify thread

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

`/threads/{thread_id}/messages`

GET - List messages
POST - Create message

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

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

DELETE - Delete message
GET - Retrieve message
POST - Modify message

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

`/threads/{thread_id}/runs`

GET - List runs
POST - Create run

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

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

GET - Retrieve run
POST - Modify run

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

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

POST - Cancel a run

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

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

GET - List run steps

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 - Retrieve 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 - Submit tool outputs to run

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

`/uploads`

POST - Create upload

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

`/uploads/{upload_id}/cancel`

POST - Cancel upload

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

`/uploads/{upload_id}/complete`

POST - Complete upload

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

`/uploads/{upload_id}/parts`

POST - Add upload part

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

`/vector_stores`

GET - List vector stores
POST - Create vector store

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

`/vector_stores/{vector_store_id}`

DELETE - Delete vector store
GET - Retrieve vector store
POST - Modify vector store

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

`/vector_stores/{vector_store_id}/file_batches`

POST - Create 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 - Retrieve 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 vector store file batch

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 - List 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 - List vector store files
POST - Create vector store file

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

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

DELETE - Delete vector store file
GET - Retrieve vector store file
POST - Update vector store file attributes

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 vector store file content

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 vector store

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

COPYRIGHT AND LICENSE

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.

To install OpenAPI::Client::OpenAI, copy and paste the appropriate command in to your terminal.

cpanm

cpanm OpenAPI::Client::OpenAI

CPAN shell

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)