Changes for version 0.24 - 2025-08-22
- Model Updates: Added support for new `gpt-5` series models, including `gpt-5`, `gpt-5-mini`, and `gpt-5-nano`, across various API endpoints like Assistants and Chat Completions.
- Conversations API Introduction: A new top-level `/conversations` endpoint has been added to create, retrieve, update, and delete conversations and their items. This provides a new way to manage and persist conversation state. The previous `/embeddings` endpoint has been removed to accommodate this new feature.
- Images API Streaming: The Images API now supports streaming for both image generation (`/images/generations`) and editing (`/images/edits`). New parameters such as `input_fidelity` and `partial_images` have also been introduced for more control over image results.
- Documentation and Code Examples: Replaced all Kotlin code examples with Java examples across the entire API specification. Endpoint summaries have been standardized for conciseness, with longer explanations moved into the `description` field. Additionally, internal documentation links have been updated to absolute URLs.
- File API Enhancements: The organizational file storage limit has been increased to 1 TB. A new `expires_after` parameter allows setting an expiration policy upon file creation.
- Responses API Updates: A new `conversation` parameter has been added to manage conversation state more effectively. The `user` parameter is now deprecated in favor of `safety_identifier` and `prompt_cache_key` for better user identification and caching. A `verbosity` parameter has also been added to control response conciseness.
- Other API Updates: The Batch API now includes an `output_expires_after` parameter to manage the lifecycle of output files. Many schema definitions have been updated from `oneOf` to the more flexible `anyOf`.
Documentation
Methods for OpenAI API
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 /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 /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 /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/checkpoints/{permission_id}/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/invites/{invite_id} path.
Documentation for the /organization/invites path.
Documentation for the /organization/projects/{project_id}/api_keys/{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}/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}/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/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/images path.
Documentation for the /organization/usage/moderations path.
Documentation for the /organization/usage/vector_stores path.
Documentation for the /organization/users/{user_id} path.
Documentation for the /organization/users path.
Documentation for the /realtime/sessions path.
Documentation for the /realtime/transcription_sessions 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 /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.
Modules
A client for the OpenAI API
