Changes for version 0.28 - 2026-05-23
- Documentation cleanup: rewrote the SYNOPSIS code example (was missing a comma after `prompt`, used the deprecated createCompletion endpoint, and referenced Data::Dumper without `use`-ing it). It now demonstrates the snake_case create_chat_completion form against gpt-3.5-turbo.
- Regenerated README.md from POD so it reflects the snake_case aliases being first-class and drops the now-removed DEPRECATED METHODS section.
Documentation
Index of API methods (snake_case)
Index of OpenAI API Paths
Documentation for the /assistants/{assistant_id} path.
Documentation for the /assistants path.
Documentation for the /audio/speech path.
Documentation for the /audio/transcriptions path.
Documentation for the /audio/translations path.
Documentation for the /audio/voice_consents/{consent_id} path.
Documentation for the /audio/voice_consents path.
Documentation for the /audio/voices path.
Documentation for the /batches/{batch_id}/cancel path.
Documentation for the /batches/{batch_id} path.
Documentation for the /batches path.
Documentation for the /chat/completions/{completion_id}/messages path.
Documentation for the /chat/completions/{completion_id} path.
Documentation for the /chat/completions path.
Documentation for the /chatkit/sessions/{session_id}/cancel path.
Documentation for the /chatkit/sessions path.
Documentation for the /chatkit/threads/{thread_id}/items path.
Documentation for the /chatkit/threads/{thread_id} path.
Documentation for the /chatkit/threads path.
Documentation for the /completions path.
Documentation for the /containers/{container_id}/files/{file_id}/content path.
Documentation for the /containers/{container_id}/files/{file_id} path.
Documentation for the /containers/{container_id}/files path.
Documentation for the /containers/{container_id} path.
Documentation for the /containers path.
Documentation for the /conversations/{conversation_id}/items/{item_id} path.
Documentation for the /conversations/{conversation_id}/items path.
Documentation for the /conversations/{conversation_id} path.
Documentation for the /conversations path.
Documentation for the /embeddings path.
Documentation for the /evals/{eval_id}/runs/{run_id}/output_items/{output_item_id} path.
Documentation for the /evals/{eval_id}/runs/{run_id}/output_items path.
Documentation for the /evals/{eval_id}/runs/{run_id} path.
Documentation for the /evals/{eval_id}/runs path.
Documentation for the /evals/{eval_id} path.
Documentation for the /evals path.
Documentation for the /files/{file_id}/content path.
Documentation for the /files/{file_id} path.
Documentation for the /files path.
Documentation for the /fine_tuning/alpha/graders/run path.
Documentation for the /fine_tuning/alpha/graders/validate path.
Documentation for the /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id} path.
Documentation for the /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions path.
Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/cancel path.
Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints path.
Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/events path.
Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/pause path.
Documentation for the /fine_tuning/jobs/{fine_tuning_job_id}/resume path.
Documentation for the /fine_tuning/jobs/{fine_tuning_job_id} path.
Documentation for the /fine_tuning/jobs path.
Documentation for the /images/edits path.
Documentation for the /images/generations path.
Documentation for the /images/variations path.
Documentation for the /models/{model} path.
Documentation for the /models path.
Documentation for the /moderations path.
Documentation for the /organization/admin_api_keys/{key_id} path.
Documentation for the /organization/admin_api_keys path.
Documentation for the /organization/audit_logs path.
Documentation for the /organization/certificates/activate path.
Documentation for the /organization/certificates/{certificate_id} path.
Documentation for the /organization/certificates/deactivate path.
Documentation for the /organization/certificates path.
Documentation for the /organization/costs path.
Documentation for the /organization/data_retention path.
Documentation for the /organization/groups/{group_id}/roles/{role_id} path.
Documentation for the /organization/groups/{group_id}/roles path.
Documentation for the /organization/groups/{group_id}/users/{user_id} path.
Documentation for the /organization/groups/{group_id}/users path.
Documentation for the /organization/groups/{group_id} path.
Documentation for the /organization/groups path.
Documentation for the /organization/invites/{invite_id} path.
Documentation for the /organization/invites path.
Documentation for the /organization/projects/{project_id}/api_keys/{api_key_id} path.
Documentation for the /organization/projects/{project_id}/api_keys path.
Documentation for the /organization/projects/{project_id}/archive path.
Documentation for the /organization/projects/{project_id}/certificates/activate path.
Documentation for the /organization/projects/{project_id}/certificates/deactivate path.
Documentation for the /organization/projects/{project_id}/certificates path.
Documentation for the /organization/projects/{project_id}/data_retention path.
Documentation for the /organization/projects/{project_id}/groups/{group_id} path.
Documentation for the /organization/projects/{project_id}/groups path.
Documentation for the /organization/projects/{project_id}/hosted_tool_permissions path.
Documentation for the /organization/projects/{project_id}/model_permissions path.
Documentation for the /organization/projects/{project_id}/rate_limits/{rate_limit_id} path.
Documentation for the /organization/projects/{project_id}/rate_limits path.
Documentation for the /organization/projects/{project_id}/service_accounts/{service_account_id} path.
Documentation for the /organization/projects/{project_id}/service_accounts path.
Documentation for the /organization/projects/{project_id}/spend_alerts/{alert_id} path.
Documentation for the /organization/projects/{project_id}/spend_alerts path.
Documentation for the /organization/projects/{project_id}/users/{user_id} path.
Documentation for the /organization/projects/{project_id}/users path.
Documentation for the /organization/projects/{project_id} path.
Documentation for the /organization/projects path.
Documentation for the /organization/roles/{role_id} path.
Documentation for the /organization/roles path.
Documentation for the /organization/spend_alerts/{alert_id} path.
Documentation for the /organization/spend_alerts path.
Documentation for the /organization/usage/audio_speeches path.
Documentation for the /organization/usage/audio_transcriptions path.
Documentation for the /organization/usage/code_interpreter_sessions path.
Documentation for the /organization/usage/completions path.
Documentation for the /organization/usage/embeddings path.
Documentation for the /organization/usage/file_search_calls path.
Documentation for the /organization/usage/images path.
Documentation for the /organization/usage/moderations path.
Documentation for the /organization/usage/vector_stores path.
Documentation for the /organization/usage/web_search_calls path.
Documentation for the /organization/users/{user_id}/roles/{role_id} path.
Documentation for the /organization/users/{user_id}/roles path.
Documentation for the /organization/users/{user_id} path.
Documentation for the /organization/users path.
Documentation for the /projects/{project_id}/groups/{group_id}/roles/{role_id} path.
Documentation for the /projects/{project_id}/groups/{group_id}/roles path.
Documentation for the /projects/{project_id}/roles/{role_id} path.
Documentation for the /projects/{project_id}/roles path.
Documentation for the /projects/{project_id}/users/{user_id}/roles/{role_id} path.
Documentation for the /projects/{project_id}/users/{user_id}/roles path.
Documentation for the /realtime/calls/{call_id}/accept path.
Documentation for the /realtime/calls/{call_id}/hangup path.
Documentation for the /realtime/calls/{call_id}/refer path.
Documentation for the /realtime/calls/{call_id}/reject path.
Documentation for the /realtime/calls path.
Documentation for the /realtime/client_secrets path.
Documentation for the /realtime/sessions path.
Documentation for the /realtime/transcription_sessions path.
Documentation for the /realtime/translations/client_secrets path.
Documentation for the /responses/compact path.
Documentation for the /responses/input_tokens path.
Documentation for the /responses/{response_id}/cancel path.
Documentation for the /responses/{response_id}/input_items path.
Documentation for the /responses/{response_id} path.
Documentation for the /responses path.
Documentation for the /skills/{skill_id}/content path.
Documentation for the /skills/{skill_id}/versions/{version}/content path.
Documentation for the /skills/{skill_id}/versions/{version} path.
Documentation for the /skills/{skill_id}/versions path.
Documentation for the /skills/{skill_id} path.
Documentation for the /skills path.
Documentation for the /threads/runs path.
Documentation for the /threads/{thread_id}/messages/{message_id} path.
Documentation for the /threads/{thread_id}/messages path.
Documentation for the /threads/{thread_id}/runs/{run_id}/cancel path.
Documentation for the /threads/{thread_id}/runs/{run_id}/steps/{step_id} path.
Documentation for the /threads/{thread_id}/runs/{run_id}/steps path.
Documentation for the /threads/{thread_id}/runs/{run_id}/submit_tool_outputs path.
Documentation for the /threads/{thread_id}/runs/{run_id} path.
Documentation for the /threads/{thread_id}/runs path.
Documentation for the /threads/{thread_id} path.
Documentation for the /threads path.
Documentation for the /uploads/{upload_id}/cancel path.
Documentation for the /uploads/{upload_id}/complete path.
Documentation for the /uploads/{upload_id}/parts path.
Documentation for the /uploads path.
Documentation for the /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel path.
Documentation for the /vector_stores/{vector_store_id}/file_batches/{batch_id}/files path.
Documentation for the /vector_stores/{vector_store_id}/file_batches/{batch_id} path.
Documentation for the /vector_stores/{vector_store_id}/file_batches path.
Documentation for the /vector_stores/{vector_store_id}/files/{file_id}/content path.
Documentation for the /vector_stores/{vector_store_id}/files/{file_id} path.
Documentation for the /vector_stores/{vector_store_id}/files path.
Documentation for the /vector_stores/{vector_store_id}/search path.
Documentation for the /vector_stores/{vector_store_id} path.
Documentation for the /vector_stores path.
Documentation for the /videos/characters/{character_id} path.
Documentation for the /videos/characters path.
Documentation for the /videos/edits path.
Documentation for the /videos/extensions path.
Documentation for the /videos/{video_id}/content path.
Documentation for the /videos/{video_id}/remix path.
Documentation for the /videos/{video_id} path.
Documentation for the /videos path.
Modules
A client for the OpenAI API
Identifier normalisation helpers for OpenAPI::Client::OpenAI
