OpenAPI-Client-OpenAI-0.20

Changes for version 0.20 - 2025-04-06

Complete revamped documentation. Much easier to read than the near-useless Schema.pod that we used to have.

Documentation

OpenAPI::Client::OpenAI::Methods

Methods for OpenAI API

OpenAPI::Client::OpenAI::Path

Index of OpenAI API Paths

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

Documentation for the /assistants/{assistant_id} path.

OpenAPI::Client::OpenAI::Path::assistants

Documentation for the /assistants path.

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

Documentation for the /audio/speech path.

OpenAPI::Client::OpenAI::Path::audio-transcriptions

Documentation for the /audio/transcriptions path.

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

Documentation for the /audio/translations path.

OpenAPI::Client::OpenAI::Path::batches-batch_id-cancel

Documentation for the /batches/{batch_id}/cancel path.

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

Documentation for the /batches/{batch_id} path.

OpenAPI::Client::OpenAI::Path::batches

Documentation for the /batches path.

OpenAPI::Client::OpenAI::Path::chat-completions-completion_id-messages

Documentation for the /chat/completions/{completion_id}/messages path.

OpenAPI::Client::OpenAI::Path::chat-completions-completion_id

Documentation for the /chat/completions/{completion_id} path.

OpenAPI::Client::OpenAI::Path::chat-completions

Documentation for the /chat/completions path.

OpenAPI::Client::OpenAI::Path::completions

Documentation for the /completions path.

OpenAPI::Client::OpenAI::Path::embeddings

Documentation for the /embeddings path.

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

Documentation for the /files/{file_id}/content path.

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

Documentation for the /files/{file_id} path.

OpenAPI::Client::OpenAI::Path::files

Documentation for the /files path.

OpenAPI::Client::OpenAI::Path::fine_tuning-checkpoints-permission_id-permissions

Documentation for the /fine_tuning/checkpoints/{permission_id}/permissions path.

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

Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/cancel path.

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

Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints path.

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

Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/events path.

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

Documentation for the /fine_tuning/jobs/{fine_tuning_job_id} path.

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

Documentation for the /fine_tuning/jobs path.

OpenAPI::Client::OpenAI::Path::images-edits

Documentation for the /images/edits path.

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

Documentation for the /images/generations path.

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

Documentation for the /images/variations path.

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

Documentation for the /models/{model} path.

OpenAPI::Client::OpenAI::Path::models

Documentation for the /models path.

OpenAPI::Client::OpenAI::Path::moderations

Documentation for the /moderations path.

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

Documentation for the /organization/admin_api_keys/{key_id} path.

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

Documentation for the /organization/admin_api_keys path.

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

Documentation for the /organization/audit_logs path.

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

Documentation for the /organization/costs path.

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

Documentation for the /organization/invites/{invite_id} path.

OpenAPI::Client::OpenAI::Path::organization-invites

Documentation for the /organization/invites path.

OpenAPI::Client::OpenAI::Path::organization-projects-project_id-api_keys-key_id

Documentation for the /organization/projects/{project_id}/api_keys/{key_id} path.

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

Documentation for the /organization/projects/{project_id}/api_keys path.

OpenAPI::Client::OpenAI::Path::organization-projects-project_id-archive

Documentation for the /organization/projects/{project_id}/archive path.

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

Documentation for the /organization/projects/{project_id}/rate_limits/{rate_limit_id} path.

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

Documentation for the /organization/projects/{project_id}/rate_limits path.

OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts-service_account_id

Documentation for the /organization/projects/{project_id}/service_accounts/{service_account_id} path.

OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts

Documentation for the /organization/projects/{project_id}/service_accounts path.

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

Documentation for the /organization/projects/{project_id}/users/{user_id} path.

OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users

Documentation for the /organization/projects/{project_id}/users path.

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

Documentation for the /organization/projects/{project_id} path.

OpenAPI::Client::OpenAI::Path::organization-projects

Documentation for the /organization/projects path.

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

Documentation for the /organization/usage/audio_speeches path.

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

Documentation for the /organization/usage/audio_transcriptions path.

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

Documentation for the /organization/usage/code_interpreter_sessions path.

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

Documentation for the /organization/usage/completions path.

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

Documentation for the /organization/usage/embeddings path.

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

Documentation for the /organization/usage/images path.

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

Documentation for the /organization/usage/moderations path.

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

Documentation for the /organization/usage/vector_stores path.

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

Documentation for the /organization/users/{user_id} path.

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

Documentation for the /organization/users path.

OpenAPI::Client::OpenAI::Path::realtime-sessions

Documentation for the /realtime/sessions path.

OpenAPI::Client::OpenAI::Path::realtime-transcription_sessions

Documentation for the /realtime/transcription_sessions path.

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

Documentation for the /responses/{response_id}/input_items path.

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

Documentation for the /responses/{response_id} path.

OpenAPI::Client::OpenAI::Path::responses

Documentation for the /responses path.

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

Documentation for the /threads/runs path.

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

Documentation for the /threads/{thread_id}/messages/{message_id} path.

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

Documentation for the /threads/{thread_id}/messages path.

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

Documentation for the /threads/{thread_id}/runs/{run_id}/cancel path.

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

Documentation for the /threads/{thread_id}/runs/{run_id}/steps/{step_id} path.

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

Documentation for the /threads/{thread_id}/runs/{run_id}/steps path.

OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-submit_tool_outputs

Documentation for the /threads/{thread_id}/runs/{run_id}/submit_tool_outputs path.

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

Documentation for the /threads/{thread_id}/runs/{run_id} path.

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

Documentation for the /threads/{thread_id}/runs path.

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

Documentation for the /threads/{thread_id} path.

OpenAPI::Client::OpenAI::Path::threads

Documentation for the /threads path.

OpenAPI::Client::OpenAI::Path::uploads-upload_id-cancel

Documentation for the /uploads/{upload_id}/cancel path.

OpenAPI::Client::OpenAI::Path::uploads-upload_id-complete

Documentation for the /uploads/{upload_id}/complete path.

OpenAPI::Client::OpenAI::Path::uploads-upload_id-parts

Documentation for the /uploads/{upload_id}/parts path.

OpenAPI::Client::OpenAI::Path::uploads

Documentation for the /uploads path.

OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id-cancel

Documentation for the /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel path.

OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-file_batches-batch_id-files

Documentation for the /vector_stores/{vector_store_id}/file_batches/{batch_id}/files path.

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

Documentation for the /vector_stores/{vector_store_id}/file_batches/{batch_id} path.

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

Documentation for the /vector_stores/{vector_store_id}/file_batches path.

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

Documentation for the /vector_stores/{vector_store_id}/files/{file_id}/content path.

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

Documentation for the /vector_stores/{vector_store_id}/files/{file_id} path.

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

Documentation for the /vector_stores/{vector_store_id}/files path.

OpenAPI::Client::OpenAI::Path::vector_stores-vector_store_id-search

Documentation for the /vector_stores/{vector_store_id}/search path.

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

Documentation for the /vector_stores/{vector_store_id} path.

OpenAPI::Client::OpenAI::Path::vector_stores

Documentation for the /vector_stores path.

Modules

OpenAPI::Client::OpenAI

A client for the OpenAI API

Examples

Other files

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)

Changes for version 0.20 - 2025-04-06

Documentation

Modules

Examples

Other files

Module Install Instructions