From 9074fef4e28a1cbeca2828d104958b708b1580dd Mon Sep 17 00:00:00 2001 From: markstuart-oai <323302876+markstuart-oai@users.noreply.github.com> Date: Tue, 8 Sep 2026 21:32:08 -0700 Subject: [PATCH] feat(api): support expiring service account keys Castiron-Internal-PR: https://github.com/openai/openai-cli-internal/pull/69 Castiron-Source-SHA: 75e3853dc8329c82cf7966bf4e0d4870da00958b Castiron-Public-Base-SHA: f6638de713a15e7d740e7f1bbc74877fbe6ac430 --- .castiron.stats.yml | 14 +- api_reference/openapi.transformed.yml | 1020 ++++++++++------- pkg/cmd/adminorganizationauditlog.go | 2 +- pkg/cmd/adminorganizationproject.go | 2 +- .../adminorganizationprojectserviceaccount.go | 5 + ...norganizationprojectserviceaccount_test.go | 6 +- pkg/cmd/audiospeech.go | 4 +- pkg/cmd/audiotranscription.go | 4 +- pkg/cmd/audiotranslation.go | 2 +- pkg/cmd/batch.go | 2 +- pkg/cmd/betaassistant.go | 12 +- pkg/cmd/betaresponse.go | 52 +- pkg/cmd/betaresponseinputtoken.go | 12 +- pkg/cmd/betathread.go | 12 +- pkg/cmd/betathreadrun.go | 14 +- pkg/cmd/betathreadrunstep.go | 4 +- pkg/cmd/call.go | 2 +- pkg/cmd/chatcompletion.go | 42 +- pkg/cmd/completion.go | 12 +- pkg/cmd/contentprovenancecheck.go | 2 +- pkg/cmd/embedding.go | 6 +- pkg/cmd/finetuningalphagrader.go | 4 +- pkg/cmd/finetuningcheckpointpermission.go | 8 +- pkg/cmd/finetuningjob.go | 6 +- pkg/cmd/image.go | 12 +- pkg/cmd/inputtoken.go | 12 +- pkg/cmd/item.go | 4 +- pkg/cmd/moderation.go | 4 +- pkg/cmd/response.go | 50 +- pkg/cmd/serviceaccountcreation_test.go | 79 ++ pkg/cmd/upload.go | 4 +- pkg/cmd/uploadpart.go | 2 +- pkg/cmd/vectorstore.go | 2 +- pkg/cmd/vectorstorefile.go | 6 +- pkg/cmd/vectorstorefilebatch.go | 4 +- 35 files changed, 845 insertions(+), 583 deletions(-) create mode 100644 pkg/cmd/serviceaccountcreation_test.go diff --git a/.castiron.stats.yml b/.castiron.stats.yml index ffbebf45..1ae65fc2 100644 --- a/.castiron.stats.yml +++ b/.castiron.stats.yml @@ -1,8 +1,8 @@ schema_version: 1 -generation_id: 43a1b7cc-09da-4086-8fd1-456f14112910 -openapi_spec_hash: 0ac5ea4ab2546a188a36a0d370367637 -openapi_transformed_spec_hash: 6be6c39576ec27111cab26c251d2ab65 -config_hash: d92ec885ac2a08b6a4c1ff90420f0327 -codegen_sha: 440da83c56fffec6c18a4da2ce5b52b404668edf -codegen_hash: a2790b8eaf45c2658d61b1117235b43ddf5443dbc5e081fa949ce331c49d7e73 -public_codegen_sha: 1247c65d31e710b2a6f77ca801065faf3fd59f67 +generation_id: 36424a6d-29e7-4d76-a33c-b1d80eecb75b +openapi_spec_hash: 0cb51423f74235e850a5f1961f31c167 +openapi_transformed_spec_hash: 70d190d2b54dd216f7280d9fd94363f0 +config_hash: d7b82262337a543ff59106e4a32ead4e +codegen_sha: 1f1e7fdb2076f412b0a3a2fba45e5585155be07a +codegen_hash: 782c20ae20f5648db19d23e2e9dd374d70334343cabea0a89de2d92656e1ad89 +public_codegen_sha: 8e2c04546082f3776ca3fa37aca8b5886550f6c1 diff --git a/api_reference/openapi.transformed.yml b/api_reference/openapi.transformed.yml index 1cc46fbb..2e688d6e 100644 --- a/api_reference/openapi.transformed.yml +++ b/api_reference/openapi.transformed.yml @@ -2817,21 +2817,21 @@ paths: "system_fingerprint": null } description: | - **Starting a new project?** We recommend trying [Responses](https://platform.openai.com/docs/api-reference/responses) + **Starting a new project?** We recommend trying [Responses](https://developers.openai.com/api/reference/resources/responses) to take advantage of the latest OpenAI platform features. Compare - [Chat Completions with Responses](https://platform.openai.com/docs/guides/responses-vs-chat-completions?api-mode=responses). + [Chat Completions with Responses](https://developers.openai.com/api/docs/guides/migrate-to-responses?api-mode=responses). --- Creates a model response for the given chat conversation. Learn more in the - [text generation](https://platform.openai.com/docs/guides/text-generation), [vision](https://platform.openai.com/docs/guides/vision), - and [audio](https://platform.openai.com/docs/guides/audio) guides. + [text generation](https://developers.openai.com/api/docs/guides/text), [vision](https://developers.openai.com/api/docs/guides/images-vision), + and [audio](https://developers.openai.com/api/docs/guides/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](https://platform.openai.com/docs/guides/reasoning). + [refer to the reasoning guide](https://developers.openai.com/api/docs/guides/reasoning). Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed. @@ -3752,7 +3752,7 @@ paths: $ref: '#/components/schemas/IncludeEnum' description: | Additional fields to include in the response. See the `include` - parameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information. + parameter for [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29) for more information. requestBody: required: true content: @@ -4057,7 +4057,7 @@ paths: $ref: '#/components/schemas/IncludeEnum' description: | Additional fields to include in the response. See the `include` - parameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information. + parameter for [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29) for more information. responses: '200': description: OK @@ -4620,7 +4620,7 @@ paths: description: | Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. - For more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals). + For more information, see the [Evals guide](https://developers.openai.com/api/docs/guides/evals). /evals/{eval_id}: get: operationId: getEval @@ -6210,18 +6210,18 @@ paths: user. - The Assistants API supports files up to 2 million tokens and of specific - file types. See the [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for + file types. See the [Assistants Tools guide](https://developers.openai.com/api/docs/guides/tools) for details. - The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning - [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or - [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input) models. + [chat](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data) or + [completions](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data) models. - The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a specific required - [format](https://platform.openai.com/docs/api-reference/batch/request-input). + [format](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file). - For Retrieval or `file_search` ingestion, upload files here first. If you need to attach multiple uploaded files to the same vector store, use - [`/vector_stores/{vector_store_id}/file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch) + [`/vector_stores/{vector_store_id}/file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create) instead of attaching them one by one. Vector store attachment has separate limits from file upload, including 2,000 attached files per minute per organization. @@ -6746,7 +6746,7 @@ paths: "has_more": false } description: | - **NOTE:** This endpoint requires an [admin API key](../admin-api-keys). + **NOTE:** This endpoint requires an [admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys). Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint. post: @@ -6801,7 +6801,7 @@ paths: "has_more": false } description: | - **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys). + **NOTE:** Calling this endpoint requires an [admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys). This enables organization owners to share fine-tuned models with other projects in their organization. /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}: @@ -6849,7 +6849,7 @@ paths: "deleted": true } description: | - **NOTE:** This endpoint requires an [admin API key](../admin-api-keys). + **NOTE:** This endpoint requires an [admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys). Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint. /fine_tuning/jobs: @@ -7256,7 +7256,7 @@ paths: 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](https://platform.openai.com/docs/guides/model-optimization) + [Learn more about fine-tuning](https://developers.openai.com/api/docs/guides/model-optimization) get: operationId: listPaginatedFineTuningJobs tags: @@ -7432,7 +7432,7 @@ paths: description: | Get info about a fine-tuning job. - [Learn more about fine-tuning](https://platform.openai.com/docs/guides/model-optimization) + [Learn more about fine-tuning](https://developers.openai.com/api/docs/guides/model-optimization) /fine_tuning/jobs/{fine_tuning_job_id}/cancel: post: operationId: cancelFineTuningJob @@ -8105,7 +8105,7 @@ paths: event: image_generation.completed data: {"type":"image_generation.completed","b64_json":"...","usage":{"total_tokens":100,"input_tokens":50,"output_tokens":50,"input_tokens_details":{"text_tokens":10,"image_tokens":40}}} description: | - Creates an image given a prompt. [Learn more](https://platform.openai.com/docs/guides/images). + Creates an image given a prompt. [Learn more](https://developers.openai.com/api/docs/guides/images-vision). /images/variations: post: operationId: createImageVariation @@ -8635,7 +8635,7 @@ paths: } description: | Classifies if text and/or image inputs are potentially harmful. Learn - more in the [moderation guide](https://platform.openai.com/docs/guides/moderation). + more in [the moderation guide](https://developers.openai.com/api/docs/guides/moderation). /organization/admin_api_keys: get: security: @@ -8910,7 +8910,7 @@ paths: type: string - name: event_types[] in: query - description: Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object). + description: Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs). required: false schema: type: array @@ -16103,7 +16103,7 @@ paths: type: string description: |- The identifier for the call provided in the - [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming) + [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming) webhook. requestBody: required: true @@ -16149,10 +16149,10 @@ paths: type: string description: |- The identifier for the call. For SIP calls, use the value provided in the - [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming) + [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming) webhook. For WebRTC sessions, reuse the call ID returned in the `Location` header when creating the call with - [`POST /v1/realtime/calls`](https://platform.openai.com/docs/api-reference/realtime/create-call). + [`POST /v1/realtime/calls`](https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create). responses: '200': description: Call hangup initiated successfully. @@ -16182,7 +16182,7 @@ paths: type: string description: |- The identifier for the call provided in the - [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming) + [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming) webhook. requestBody: required: true @@ -16220,7 +16220,7 @@ paths: type: string description: |- The identifier for the call provided in the - [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming) + [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming) webhook. requestBody: required: false @@ -16341,7 +16341,7 @@ paths: applied to any sessions created using that client secret, but these can also be overridden by the client connection. - [Learn more about authentication with client secrets over WebRTC](https://platform.openai.com/docs/guides/realtime-webrtc). + [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc). Returns the created client secret and the effective session object. The client secret is a string that looks like `ek_1234`. /realtime/sessions: @@ -17727,12 +17727,12 @@ paths: "metadata": {} } description: | - Creates a model response. Provide [text](https://platform.openai.com/docs/guides/text) or - [image](https://platform.openai.com/docs/guides/images) inputs to generate [text](https://platform.openai.com/docs/guides/text) - or [JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have the model call - your own [custom code](https://platform.openai.com/docs/guides/function-calling) or use built-in - [tools](https://platform.openai.com/docs/guides/tools) like [web search](https://platform.openai.com/docs/guides/tools-web-search) - or [file search](https://platform.openai.com/docs/guides/tools-file-search) to use your own data + Creates a model response. Provide [text](https://developers.openai.com/api/docs/guides/text) or + [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to generate [text](https://developers.openai.com/api/docs/guides/text) + or [JSON](https://developers.openai.com/api/docs/guides/structured-outputs) outputs. Have the model call + your own [custom code](https://developers.openai.com/api/docs/guides/function-calling) or use built-in + [tools](https://developers.openai.com/api/docs/guides/tools) like [web search](https://developers.openai.com/api/docs/guides/tools-web-search) + or [file search](https://developers.openai.com/api/docs/guides/tools-file-search) to use your own data as input for the model's response. /responses/{response_id}: get: @@ -17764,7 +17764,7 @@ paths: description: | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). - See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) + See the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events) for more information. - in: query name: starting_after @@ -18027,7 +18027,10 @@ paths: "user": null, "metadata": {} } - description: "Cancels a model response with the given ID. Only responses created with\nthe `background` parameter set to `true` can be cancelled. \n[Learn more](https://platform.openai.com/docs/guides/background).\n" + description: | + Cancels a model response with the given ID. Only responses created with + the `background` parameter set to `true` can be cancelled. + [Learn more](https://developers.openai.com/api/docs/guides/background). /responses/{response_id}/input_items: get: operationId: listInputItems @@ -18844,7 +18847,7 @@ paths: required: true schema: type: string - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) the messages belong to. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) the messages belong to. - name: limit in: query description: | @@ -18982,7 +18985,7 @@ paths: required: true schema: type: string - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) to create a message for. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) to create a message for. requestBody: required: true content: @@ -19072,7 +19075,7 @@ paths: required: true schema: type: string - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) to which this message belongs. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) to which this message belongs. - in: path name: message_id required: true @@ -19523,7 +19526,7 @@ paths: description: | A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. + See the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information. schema: type: array items: @@ -19872,7 +19875,7 @@ paths: required: true schema: type: string - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) that was run. - in: path name: run_id required: true @@ -19975,7 +19978,7 @@ paths: required: true schema: type: string - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) that was run. - in: path name: run_id required: true @@ -20248,7 +20251,7 @@ paths: description: | A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. + See the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information. schema: type: array items: @@ -20364,7 +20367,7 @@ paths: description: | A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. + See the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information. schema: type: array items: @@ -20455,7 +20458,7 @@ paths: required: true schema: type: string - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) to which this run belongs. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) to which this run belongs. - in: path name: run_id required: true @@ -20748,7 +20751,26 @@ paths: "status": "pending", "expires_at": 1719127296 } - description: "Creates an intermediate [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object\nthat you can add [Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.\nCurrently, an Upload can accept at most 8 GB in total and expires after an\nhour after you create it.\n\nOnce you complete the Upload, we will create a\n[File](https://platform.openai.com/docs/api-reference/files/object) object that contains all the parts\nyou uploaded. This File is usable in the rest of our platform as a regular\nFile object.\n\nFor certain `purpose` values, the correct `mime_type` must be specified. \nPlease refer to documentation for the \n[supported MIME types for your use case](https://platform.openai.com/docs/assistants/tools/file-search#supported-files).\n\nFor guidance on the proper filename extensions for each purpose, please\nfollow the documentation on [creating a\nFile](https://platform.openai.com/docs/api-reference/files/create).\n\nReturns the Upload object with status `pending`.\n" + description: | + Creates an intermediate [Upload](https://developers.openai.com/api/reference/resources/uploads) object + that you can add [Parts](https://developers.openai.com/api/reference/resources/uploads/subresources/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](https://developers.openai.com/api/reference/resources/files) 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](https://developers.openai.com/api/docs/guides/tools-file-search#supported-files). + + For guidance on the proper filename extensions for each purpose, please + follow the documentation on [creating a + File](https://developers.openai.com/api/reference/resources/files/methods/create). + + Returns the Upload object with status `pending`. /uploads/{upload_id}/cancel: post: operationId: cancelUpload @@ -20851,7 +20873,15 @@ paths: "purpose": "fine-tune", } } - description: "Completes the [Upload](https://platform.openai.com/docs/api-reference/uploads/object). \n\nWithin the returned Upload object, there is a nested [File](https://platform.openai.com/docs/api-reference/files/object) object that is ready to use in the rest of the platform.\n\nYou can specify the order of the Parts by passing in an ordered list of the Part IDs.\n\nThe 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.\nReturns the Upload object with status `completed`, including an additional `file` property containing the created usable File object.\n" + description: | + Completes the [Upload](https://developers.openai.com/api/reference/resources/uploads). + + Within the returned Upload object, there is a nested [File](https://developers.openai.com/api/reference/resources/files) 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. + Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object. /uploads/{upload_id}/parts: post: operationId: addUploadPart @@ -20895,7 +20925,12 @@ paths: "created_at": 1719185911, "upload_id": "upload_abc123" } - description: "Adds a [Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. \n\nEach Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.\n\nIt is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete).\n" + description: | + Adds a [Part](https://developers.openai.com/api/reference/resources/uploads/subresources/parts) to an [Upload](https://developers.openai.com/api/reference/resources/uploads) 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](https://developers.openai.com/api/reference/resources/uploads/methods/complete). /vector_stores: get: operationId: listVectorStores @@ -21797,7 +21832,7 @@ paths: tags: - Vector stores summary: Create vector store file - description: Create a vector store file by attaching a [File](https://platform.openai.com/docs/api-reference/files) to a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object). + description: Create a vector store file by attaching a [File](https://developers.openai.com/api/reference/resources/files) to a [vector store](https://developers.openai.com/api/reference/resources/vector_stores). parameters: - in: path name: vector_store_id @@ -22009,7 +22044,7 @@ paths: object: "vector_store.file.deleted", deleted: true } - description: 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](https://platform.openai.com/docs/api-reference/files/delete) endpoint. + description: 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](https://developers.openai.com/api/reference/resources/files/methods/delete) endpoint. post: operationId: updateVectorStoreFileAttributes tags: @@ -22860,7 +22895,7 @@ paths: name: Create content provenance check group: content_provenance_checks description: |- - Check whether an image or audio file contains known OpenAI provenance signals. [Learn more about content provenance](/api/docs/guides/content-provenance). + Check whether an image or audio file contains known OpenAI provenance signals. [Learn more about content provenance](https://developers.openai.com/api/docs/guides/content-provenance). If `not_detected`, it means the tool did not find supported signals in the uploaded file. The content could still have been generated by OpenAI if the metadata was stripped or has evidence of tampering, the watermark was degraded, it comes from a legacy generation model, or it was created before provenance signals were available. Content could also still be AI-generated by another company's model, which the tool currently does not detect. /videos: @@ -23882,7 +23917,7 @@ paths: description: |- Compact a conversation. Returns a compacted response object. - Learn when and how to compact long-running conversations in the [conversation state guide](https://platform.openai.com/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced). + Learn when and how to compact long-running conversations in the [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced). /skills: post: tags: @@ -26192,12 +26227,12 @@ paths: enum: - responses_multi_agent=v1 description: | - Creates a model response. Provide [text](https://platform.openai.com/docs/guides/text) or - [image](https://platform.openai.com/docs/guides/images) inputs to generate [text](https://platform.openai.com/docs/guides/text) - or [JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have the model call - your own [custom code](https://platform.openai.com/docs/guides/function-calling) or use built-in - [tools](https://platform.openai.com/docs/guides/tools) like [web search](https://platform.openai.com/docs/guides/tools-web-search) - or [file search](https://platform.openai.com/docs/guides/tools-file-search) to use your own data + Creates a model response. Provide [text](https://developers.openai.com/api/docs/guides/text) or + [image](https://developers.openai.com/api/docs/guides/images-vision) inputs to generate [text](https://developers.openai.com/api/docs/guides/text) + or [JSON](https://developers.openai.com/api/docs/guides/structured-outputs) outputs. Have the model call + your own [custom code](https://developers.openai.com/api/docs/guides/function-calling) or use built-in + [tools](https://developers.openai.com/api/docs/guides/tools) like [web search](https://developers.openai.com/api/docs/guides/tools-web-search) + or [file search](https://developers.openai.com/api/docs/guides/tools-file-search) to use your own data as input for the model's response. /responses/{response_id}?beta=true: get: @@ -26229,7 +26264,7 @@ paths: description: | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). - See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) + See the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events) for more information. - in: query name: starting_after @@ -26531,7 +26566,10 @@ paths: "user": null, "metadata": {} } - description: "Cancels a model response with the given ID. Only responses created with\nthe `background` parameter set to `true` can be cancelled. \n[Learn more](https://platform.openai.com/docs/guides/background).\n" + description: | + Cancels a model response with the given ID. Only responses created with + the `background` parameter set to `true` can be cancelled. + [Learn more](https://developers.openai.com/api/docs/guides/background). /responses/compact?beta=true: post: summary: Compact a response @@ -26702,7 +26740,7 @@ paths: description: |- Compact a conversation. Returns a compacted response object. - Learn when and how to compact long-running conversations in the [conversation state guide](https://platform.openai.com/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced). + Learn when and how to compact long-running conversations in the [conversation state guide](https://developers.openai.com/api/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, see [Compaction (advanced)](https://developers.openai.com/api/docs/guides/conversation-state#compaction-advanced). /responses/{response_id}/input_items?beta=true: get: operationId: beta_listInputItems @@ -27414,7 +27452,7 @@ components: - type: 'null' model: description: | - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. + ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them. type: string instructions: anyOf: @@ -27443,7 +27481,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -27454,7 +27492,7 @@ components: vector_store_ids: type: array description: | - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. maxItems: 1 items: type: string @@ -27538,7 +27576,7 @@ components: `thread.message.completed` event. We may add additional events over time, so we recommend handling unknown events gracefully - in your code. See the [Assistants API quickstart](https://platform.openai.com/docs/assistants/overview) to learn how to + in your code. See the [Assistants API quickstart](https://developers.openai.com/api/docs/assistants/migration) to learn how to integrate the Assistants API with streaming. x-oaiMeta: name: Assistant stream events @@ -27630,7 +27668,7 @@ components: description: | The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive. - Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. + Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information. ranking_options: $ref: '#/components/schemas/FileSearchRankingOptions' required: @@ -27664,9 +27702,9 @@ components: - function AssistantsApiResponseFormatOption: description: | - Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. + Specifies the format that the model must output. Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o), [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. - Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs). + Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. @@ -27773,7 +27811,7 @@ components: description: | An optional text to guide the model's style or continue a previous audio segment. - For `whisper-1`, the [prompt is a list of keywords](https://platform.openai.com/docs/guides/speech-to-text#prompting). + For `whisper-1`, the [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting). For `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example "expect words related to technology". Prompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions. delay: @@ -28883,7 +28921,7 @@ components: Model ID used to process the batch, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model - guide](https://platform.openai.com/docs/models) to browse and compare available models. + guide](https://developers.openai.com/api/docs/models) to browse and compare available models. errors: type: object properties: @@ -28974,7 +29012,7 @@ components: type: integer description: | The number of tokens that were retrieved from the cache. [More on - prompt caching](https://platform.openai.com/docs/guides/prompt-caching). + prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching). required: - cached_tokens output_tokens: @@ -29543,7 +29581,7 @@ components: `["text"]` - The `gpt-4o-audio-preview` model can also be used to [generate audio](https://platform.openai.com/docs/guides/audio). To + The `gpt-4o-audio-preview` model can also be used to [generate audio](https://developers.openai.com/api/docs/guides/audio). To request that this model generate both text and audio responses, you can use: @@ -29701,7 +29739,7 @@ components: - type: object description: | Data about a previous audio response from the model. - [Learn more](https://platform.openai.com/docs/guides/audio). + [Learn more](https://developers.openai.com/api/docs/guides/audio). required: - id properties: @@ -29810,7 +29848,7 @@ components: type: object title: Audio content part description: | - Learn about [audio inputs](https://platform.openai.com/docs/guides/audio). + Learn about [audio inputs](https://developers.openai.com/api/docs/guides/audio). properties: type: type: string @@ -29846,7 +29884,7 @@ components: type: object title: File content part description: | - Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation. + Learn about [file inputs](https://developers.openai.com/api/docs/guides/text) for text generation. properties: type: type: string @@ -29859,10 +29897,14 @@ components: properties: filename: type: string - description: "The name of the file, used when passing the file to the model as a \nstring.\n" + description: | + The name of the file, used when passing the file to the model as a + string. file_data: type: string - description: "The base64 encoded file data, used when passing the file to the model \nas a string.\n" + description: | + The base64 encoded file data, used when passing the file to the model + as a string. file_id: type: string description: | @@ -29884,7 +29926,7 @@ components: type: object title: Image content part description: | - Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision). properties: type: type: string @@ -29901,7 +29943,7 @@ components: format: uri detail: type: string - description: Specifies the detail level of the image. Learn more in the [Vision guide](https://platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding). + description: Specifies the detail level of the image. Learn more in the [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level). enum: - auto - low @@ -29937,7 +29979,7 @@ components: type: object title: Text content part description: | - Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation). + Learn about [text inputs](https://developers.openai.com/api/docs/guides/text). properties: type: type: string @@ -30044,7 +30086,7 @@ components: description: The text contents of the message. title: Text content - type: array - description: An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text, image, or audio inputs. + description: An array of content parts with a defined type. Supported options differ based on the [model](https://developers.openai.com/api/docs/models) being used to generate the response. Can contain text, image, or audio inputs. title: Array of content parts items: $ref: '#/components/schemas/ChatCompletionRequestUserMessageContentPart' @@ -30092,7 +30134,7 @@ components: type: array description: | Annotations for the message, when applicable, as when using the - [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). + [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search). items: type: object description: | @@ -30154,7 +30196,7 @@ components: - type: object description: | If the audio output modality is requested, this object contains data - about the audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio). + about the audio response from the model. [Learn more](https://developers.openai.com/api/docs/guides/audio). required: - id - expires_at @@ -30706,7 +30748,7 @@ components: title: Computer tool call description: | A tool call to a computer use tool. See the - [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information. + [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information. properties: type: type: string @@ -31010,7 +31052,7 @@ components: $ref: '#/components/schemas/OutputContent' ConversationItem: title: Conversation item - description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](https://platform.openai.com/docs/api-reference/responses/object#responses/object-output). + description: A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](https://developers.openai.com/api/reference/resources/responses#%28resource%29%20responses%20%3E%20%28model%29%20response%20%3E%20%28schema%29%20%3E%20%28property%29%20output). discriminator: propertyName: type anyOf: @@ -31161,7 +31203,7 @@ components: properties: model: description: | - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. + ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them. example: gpt-5 anyOf: - type: string @@ -31210,7 +31252,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -31221,14 +31263,14 @@ components: vector_store_ids: type: array description: | - The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + The [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. maxItems: 1 items: type: string vector_stores: type: array description: | - A helper to create a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. + A helper to create a [vector store](https://developers.openai.com/api/reference/resources/vector_stores) with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. maxItems: 1 items: type: object @@ -31236,7 +31278,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. maxItems: 100000000 items: type: string @@ -31340,9 +31382,9 @@ components: description: | The ID of an uploaded file that contains requests for the new batch. - See [upload file](https://platform.openai.com/docs/api-reference/files/create) for how to upload a file. + See [upload file](https://developers.openai.com/api/reference/resources/files/methods/create) for how to upload a file. - Your input file must be formatted as a [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size. + Your input file must be formatted as a [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size. endpoint: type: string enum: @@ -31372,9 +31414,9 @@ components: messages: description: | A list of messages comprising the conversation so far. Depending on the - [model](https://platform.openai.com/docs/models) you use, different message types (modalities) are - supported, like [text](https://platform.openai.com/docs/guides/text-generation), - [images](https://platform.openai.com/docs/guides/vision), and [audio](https://platform.openai.com/docs/guides/audio). + [model](https://developers.openai.com/api/docs/models) you use, different message types (modalities) are + supported, like [text](https://developers.openai.com/api/docs/guides/text), + [images](https://developers.openai.com/api/docs/guides/images-vision), and [audio](https://developers.openai.com/api/docs/guides/audio). type: array minItems: 1 items: @@ -31383,7 +31425,7 @@ components: description: | Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI offers a wide range of models with different capabilities, performance - characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. $ref: '#/components/schemas/ModelIdsShared' service_tier: @@ -31396,7 +31438,7 @@ components: $ref: '#/components/schemas/ReasoningEffort' max_completion_tokens: description: | - An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning). type: integer nullable: true frequency_penalty: @@ -31424,7 +31466,7 @@ components: title: Web search description: | This tool searches the web for relevant results to use in a response. - Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). + Learn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search). properties: user_location: type: object @@ -31464,7 +31506,7 @@ components: Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). + guide](https://developers.openai.com/api/docs/guides/structured-outputs). Setting to `{ "type": "json_object" }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` @@ -31480,7 +31522,7 @@ components: nullable: true description: | Parameters for audio output. Required when audio output is requested with - `modalities: ["audio"]`. [Learn more](https://platform.openai.com/docs/guides/audio). + `modalities: ["audio"]`. [Learn more](https://developers.openai.com/api/docs/guides/audio). required: - voice - format @@ -31510,8 +31552,8 @@ components: nullable: true description: | Whether or not to store the output of this chat completion request for - use in our [model distillation](https://platform.openai.com/docs/guides/distillation) or - [evals](https://platform.openai.com/docs/guides/evals) products. + use in our [model distillation](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#distilling-from-a-larger-model) or + [evals](https://developers.openai.com/api/docs/guides/evals) products. Supports text and image inputs. Note: image inputs over 8MB will be dropped. moderation: @@ -31524,8 +31566,8 @@ components: description: | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). - See the [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming) - for more information, along with the [streaming responses](https://platform.openai.com/docs/guides/streaming-responses) + See the [Streaming section below](https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events) + for more information, along with the [streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses) guide for more information on how to handle the streaming events. type: boolean nullable: true @@ -31558,12 +31600,12 @@ components: nullable: true max_tokens: description: | - The maximum number of [tokens](/tokenizer) that can be generated in the + The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API. This value is now deprecated in favor of `max_completion_tokens`, and is - not compatible with [o-series models](https://platform.openai.com/docs/guides/reasoning). + not compatible with [o-series models](https://developers.openai.com/api/docs/guides/reasoning). type: integer nullable: true deprecated: true @@ -31578,7 +31620,7 @@ components: prediction: nullable: true description: | - Configuration for a [Predicted Output](https://platform.openai.com/docs/guides/predicted-outputs), + Configuration for a [Predicted Output](https://developers.openai.com/api/docs/guides/predicted-outputs), which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content. @@ -31604,8 +31646,8 @@ components: type: array description: | A list of tools the model may call. You can provide either - [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools) or - [function tools](https://platform.openai.com/docs/guides/function-calling). + [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools) or + [function tools](https://developers.openai.com/api/docs/guides/function-calling). items: anyOf: - $ref: '#/components/schemas/ChatCompletionTool' @@ -31804,7 +31846,10 @@ components: } CreateChatCompletionStreamResponse: type: object - description: "Represents a streamed chunk of a chat completion response returned\nby the model, based on the provided input. \n[Learn more](https://platform.openai.com/docs/guides/streaming-responses).\n" + description: | + Represents a streamed chunk of a chat completion response returned + by the model, based on the provided input. + [Learn more](https://developers.openai.com/api/docs/guides/streaming-responses). properties: id: type: string @@ -31928,7 +31973,7 @@ components: properties: model: description: | - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. + ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them. anyOf: - type: string - type: string @@ -31994,7 +32039,7 @@ components: description: | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. - [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation) + [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text) logit_bias: type: object x-oaiTypeLabel: map @@ -32005,7 +32050,7 @@ components: description: | Modify the likelihood of specified tokens appearing in the completion. - Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token from being generated. logprobs: @@ -32025,7 +32070,7 @@ components: example: 16 nullable: true description: | - The maximum number of [tokens](/tokenizer) that can be generated in the completion. + The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. n: @@ -32048,7 +32093,7 @@ components: description: | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. - [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation) + [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text) seed: type: integer format: int64 @@ -32102,7 +32147,7 @@ components: type: string example: user-1234 description: | - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). + A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). required: - model - prompt @@ -32281,7 +32326,7 @@ components: properties: input: description: | - Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request. + Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request. example: The quick brown fox jumped over the lazy dog anyOf: - type: string @@ -32317,7 +32362,7 @@ components: type: integer model: description: | - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. + ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them. example: text-embedding-3-small anyOf: - type: string @@ -32345,7 +32390,7 @@ components: type: string example: user-1234 description: | - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). + A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). required: - model - input @@ -32460,7 +32505,7 @@ components: Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). + guide](https://developers.openai.com/api/docs/guides/structured-outputs). Setting to `{ "type": "json_object" }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` @@ -32818,12 +32863,12 @@ components: The two categories of tools you can provide the model are: - **Built-in tools**: Tools that are provided by OpenAI that extend the - model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) - or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about - [built-in tools](https://platform.openai.com/docs/guides/tools). + model's capabilities, like [web search](https://developers.openai.com/api/docs/guides/tools-web-search) + or [file search](https://developers.openai.com/api/docs/guides/tools-file-search). Learn more about + [built-in tools](https://developers.openai.com/api/docs/guides/tools). - **Function calls (custom tools)**: Functions that are defined by you, enabling the model to call your own code. Learn more about - [function calling](https://platform.openai.com/docs/guides/function-calling). + [function calling](https://developers.openai.com/api/docs/guides/function-calling). items: $ref: '#/components/schemas/Tool' text: @@ -32831,8 +32876,8 @@ components: description: | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) - - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs) + - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) + - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs) properties: format: $ref: '#/components/schemas/TextResponseFormatConfiguration' @@ -32960,7 +33005,7 @@ components: model: description: | The name of the model to fine-tune. You can select one of the - [supported models](https://platform.openai.com/docs/guides/fine-tuning#which-models-can-be-fine-tuned). + [supported models](https://developers.openai.com/api/docs/guides/model-optimization#fine-tuning-methods). example: gpt-4o-mini anyOf: - type: string @@ -32976,13 +33021,13 @@ components: description: | The ID of an uploaded file that contains training data. - See [upload file](https://platform.openai.com/docs/api-reference/files/create) for how to upload a file. + See [upload file](https://developers.openai.com/api/reference/resources/files/methods/create) for how to upload a file. Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`. - The contents of the file should differ depending on if the model uses the [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input), [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input) format, or if the fine-tuning method uses the [preference](https://platform.openai.com/docs/api-reference/fine-tuning/preference-input) format. + The contents of the file should differ depending on if the model uses the [chat](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data), [completions](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data) format, or if the fine-tuning method uses the [preference](https://developers.openai.com/api/docs/guides/direct-preference-optimization) format. - See the [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization) for more details. + See the [fine-tuning guide](https://developers.openai.com/api/docs/guides/model-optimization) for more details. type: string example: file-abc123 hyperparameters: @@ -33054,7 +33099,7 @@ components: Your dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`. - See the [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization) for more details. + See the [fine-tuning guide](https://developers.openai.com/api/docs/guides/model-optimization) for more details. type: string nullable: true example: file-abc123 @@ -33287,7 +33332,7 @@ components: type: string example: user-1234 description: | - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). + A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). input_fidelity: anyOf: - $ref: '#/components/schemas/InputFidelity' @@ -33300,7 +33345,7 @@ components: nullable: true description: | Edit the image in streaming mode. Defaults to `false`. See the - [Image generation guide](https://platform.openai.com/docs/guides/image-generation) for more information. + [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation) for more information. partial_images: $ref: '#/components/schemas/PartialImages' quality: @@ -33414,7 +33459,7 @@ components: nullable: true description: | Generate the image in streaming mode. Defaults to `false`. See the - [Image generation guide](https://platform.openai.com/docs/guides/image-generation) for more information. + [Image generation guide](https://developers.openai.com/api/docs/guides/image-generation) for more information. This parameter is only supported for the GPT image models. partial_images: $ref: '#/components/schemas/PartialImages' @@ -33475,7 +33520,7 @@ components: type: string example: user-1234 description: | - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). + A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). required: - prompt CreateImageVariationRequest: @@ -33528,7 +33573,7 @@ components: type: string example: user-1234 description: | - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids). + A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). required: - image CreateMessageRequest: @@ -33553,7 +33598,7 @@ components: description: The text contents of the message. title: Text content - type: array - description: An array of content parts with a defined type, each can be of type `text` or images can be passed with `image_url` or `image_file`. Image types are only supported on [Vision-compatible models](https://platform.openai.com/docs/models). + description: An array of content parts with a defined type, each can be of type `text` or images can be passed with `image_url` or `image_file`. Image types are only supported on [Vision-compatible models](https://developers.openai.com/api/docs/models). title: Array of content parts items: anyOf: @@ -33636,8 +33681,7 @@ components: model: description: | The content moderation model you would like to use. Learn more in - [the moderation guide](https://platform.openai.com/docs/guides/moderation), and learn about - available models [here](https://platform.openai.com/docs/models#moderation). + [the moderation guide](https://developers.openai.com/api/docs/guides/moderation). nullable: false x-oaiTypeLabel: string anyOf: @@ -34069,7 +34113,7 @@ components: Whether to store the generated model response for later retrieval via API. Defaults to true when omitted. - If set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](/api/docs/guides/your-data#v1responses). + If set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses). default: true - type: 'null' instructions: @@ -34093,7 +34137,7 @@ components: - description: | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). - See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) + See the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events) for more information. type: boolean default: false @@ -34116,7 +34160,7 @@ components: max_output_tokens: anyOf: - description: | - An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning). type: integer minimum: 16 - type: 'null' @@ -34125,10 +34169,10 @@ components: additionalProperties: false properties: assistant_id: - description: The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run. + description: The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run. type: string model: - description: The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + description: The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. nullable: true anyOf: - type: string @@ -34137,7 +34181,7 @@ components: reasoning_effort: $ref: '#/components/schemas/ReasoningEffort' instructions: - description: Overrides the [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis. + description: Overrides the [instructions](https://developers.openai.com/api/docs/assistants/migration) of the assistant. This is useful for modifying the behavior on a per-run basis. type: string nullable: true additional_instructions: @@ -34217,7 +34261,7 @@ components: properties: model: description: | - One of the available [TTS models](https://platform.openai.com/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`. + One of the available [TTS models](https://developers.openai.com/api/docs/guides/text-to-speech): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`. anyOf: - type: string - type: string @@ -34237,7 +34281,7 @@ components: description: Control the voice of your generated audio with additional instructions. Does not work with `tts-1` or `tts-1-hd`. maxLength: 4096 voice: - description: 'The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the voices are available in the [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).' + description: 'The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the voices are available in the [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).' $ref: '#/components/schemas/VoiceIdsOrCustomVoice' response_format: description: The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`. @@ -34303,12 +34347,12 @@ components: additionalProperties: false properties: assistant_id: - description: The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run. + description: The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run. type: string thread: $ref: '#/components/schemas/CreateThreadRequest' model: - description: The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + description: The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. nullable: true anyOf: - type: string @@ -34375,7 +34419,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -34386,7 +34430,7 @@ components: vector_store_ids: type: array description: | - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. maxItems: 1 items: type: string @@ -34453,7 +34497,7 @@ components: additionalProperties: false properties: messages: - description: A list of [messages](https://platform.openai.com/docs/api-reference/messages) to start the thread with. + description: A list of [messages](https://developers.openai.com/api/docs/assistants/migration) to start the thread with. type: array items: $ref: '#/components/schemas/CreateMessageRequest' @@ -34469,7 +34513,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -34480,14 +34524,14 @@ components: vector_store_ids: type: array description: | - The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. + The [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this thread. There can be a maximum of 1 vector store attached to the thread. maxItems: 1 items: type: string vector_stores: type: array description: | - A helper to create a [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. + A helper to create a [vector store](https://developers.openai.com/api/reference/resources/vector_stores) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. maxItems: 1 items: type: object @@ -34495,7 +34539,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs to add to the vector store. For vector stores created before Nov 2025, there can be a maximum of 10,000 files in a vector store. For vector stores created starting in Nov 2025, the limit is 100,000,000 files. maxItems: 100000000 items: type: string @@ -34608,7 +34652,7 @@ components: type: string prompt: description: | - An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-diarize`. + An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-diarize`. type: string response_format: $ref: '#/components/schemas/AudioResponseFormat' @@ -34644,7 +34688,7 @@ components: - description: | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). - See the [Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions) + See the [Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming) for more information. Note: Streaming is not supported for the `whisper-1` model and will be ignored. @@ -34893,7 +34937,7 @@ components: x-oaiTypeLabel: string prompt: description: | - An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting) should be in English. + An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting) should be in English. type: string response_format: description: | @@ -34956,7 +35000,7 @@ components: The intended purpose of the uploaded file. See the [documentation on File - purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose). + purposes](https://developers.openai.com/api/reference/resources/files/methods/create#%28resource%29%20files%20%3E%20%28method%29%20create%20%3E%20%28params%29%200%20%3E%20%28param%29%20purpose%20%3E%20%28schema%29). type: string enum: - assistants @@ -34987,7 +35031,7 @@ components: additionalProperties: false properties: file_ids: - description: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`. + description: A list of [File](https://developers.openai.com/api/reference/resources/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`. type: array minItems: 1 maxItems: 2000 @@ -35009,7 +35053,7 @@ components: additionalProperties: false properties: file_id: - description: A [File](https://platform.openai.com/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests. + description: A [File](https://developers.openai.com/api/reference/resources/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create) to minimize per-vector-store write requests. type: string chunking_strategy: $ref: '#/components/schemas/ChunkingStrategyRequestParam' @@ -35022,7 +35066,7 @@ components: additionalProperties: false properties: file_ids: - description: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. + description: A list of [File](https://developers.openai.com/api/reference/resources/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. type: array maxItems: 500 items: @@ -35693,7 +35737,7 @@ components: embedding: type: array description: | - The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](https://platform.openai.com/docs/guides/embeddings). + The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](https://developers.openai.com/api/docs/guides/embeddings). items: type: number format: float @@ -35755,9 +35799,9 @@ components: required: - event - data - description: Occurs when an [error](https://platform.openai.com/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout. + description: Occurs when an [error](https://developers.openai.com/api/docs/guides/error-codes#api-errors) occurs. This can happen due to an internal server error or a timeout. x-oaiMeta: - dataDescription: '`data` is an [error](/docs/guides/error-codes#api-errors)' + dataDescription: '`data` is an [error](https://developers.openai.com/api/docs/guides/error-codes#api-errors)' ErrorResponse: type: object properties: @@ -37232,7 +37276,7 @@ components: description: | The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0. - See the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information. + See the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information. properties: ranker: $ref: '#/components/schemas/FileSearchRanker' @@ -37248,7 +37292,7 @@ components: title: File search tool call description: | The results of a file search tool call. See the - [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information. + [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information. properties: id: type: string @@ -37738,7 +37782,7 @@ components: description: The organization that owns the fine-tuning job. result_files: type: array - description: The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents). + description: The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](https://developers.openai.com/api/reference/resources/files/methods/content). items: type: string example: file-abc123 @@ -37759,11 +37803,11 @@ components: - type: 'null' training_file: type: string - description: The file ID used for training. You can retrieve the training data with the [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents). + description: The file ID used for training. You can retrieve the training data with the [Files API](https://developers.openai.com/api/reference/resources/files/methods/content). validation_file: anyOf: - type: string - description: The file ID used for validation. You can retrieve the validation results with the [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents). + description: The file ID used for validation. You can retrieve the validation results with the [Files API](https://developers.openai.com/api/reference/resources/files/methods/content). - type: 'null' integrations: anyOf: @@ -37995,18 +38039,23 @@ components: anyOf: - type: boolean default: false - description: Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://platform.openai.com/docs/guides/function-calling). + description: Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling). - type: 'null' required: - name FunctionParameters: type: object - description: "The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list." + description: |- + The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + + Omitting `parameters` defines a function with an empty parameter list. additionalProperties: true FunctionToolCall: type: object title: Function tool call - description: "A tool call to run a function. See the \n[function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information.\n" + description: | + A tool call to run a function. See the + [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information. properties: id: type: string @@ -39475,6 +39524,26 @@ components: - auto - type: 'null' description: The quality of the image generated by the image generation tool call. One of `low`, `medium`, `high`, `xhigh`, `max`, or `auto`. + action: + anyOf: + - $ref: '#/components/schemas/ImageGenActionEnum' + - type: 'null' + description: The action used for image generation. + background: + anyOf: + - $ref: '#/components/schemas/ImageBackground' + - type: 'null' + description: The background setting used for generation. + output_format: + anyOf: + - $ref: '#/components/schemas/ImageOutputFormat' + - type: 'null' + description: The output format used for generation. + revised_prompt: + anyOf: + - type: string + - type: 'null' + description: The prompt that was used after any model prompt rewriting. required: - type - id @@ -39730,11 +39799,11 @@ components: Text, image, or file inputs to the model, used to generate a response. Learn more: - - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) - - [Image inputs](https://platform.openai.com/docs/guides/images) - - [File inputs](https://platform.openai.com/docs/guides/pdf-files) - - [Conversation state](https://platform.openai.com/docs/guides/conversation-state) - - [Function calling](https://platform.openai.com/docs/guides/function-calling) + - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) + - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision) + - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs) + - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state) + - [Function calling](https://developers.openai.com/api/docs/guides/function-calling) anyOf: - type: string title: Text input @@ -40729,7 +40798,7 @@ components: title: MCP tool description: | Give the model access to additional tools via remote Model Context Protocol - (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp). + (MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp). properties: type: type: string @@ -40761,7 +40830,7 @@ components: description: | Identifier for service connectors, like those available in ChatGPT. One of `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more - about service connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors). Currently supported `connector_id` values are: @@ -40939,7 +41008,7 @@ components: MessageContentImageFileObject: title: Image file type: object - description: References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. + description: References an image [File](https://developers.openai.com/api/reference/resources/files) in the content of a message. properties: type: description: Always `image_file`. @@ -40951,7 +41020,7 @@ components: type: object properties: file_id: - description: The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. + description: The [File](https://developers.openai.com/api/reference/resources/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. type: string detail: type: string @@ -41111,7 +41180,7 @@ components: MessageDeltaContentImageFileObject: title: Image file type: object - description: References an image [File](https://platform.openai.com/docs/api-reference/files) in the content of a message. + description: References an image [File](https://developers.openai.com/api/reference/resources/files) in the content of a message. properties: index: type: integer @@ -41126,7 +41195,7 @@ components: type: object properties: file_id: - description: The [File](https://platform.openai.com/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. + description: The [File](https://developers.openai.com/api/reference/resources/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content. type: string detail: type: string @@ -41338,7 +41407,7 @@ components: MessageObject: type: object title: The message object - description: Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads). + description: Represents a message within a [thread](https://developers.openai.com/api/docs/assistants/migration). properties: id: description: The identifier, which can be referenced in API endpoints. @@ -41354,7 +41423,7 @@ components: type: integer format: unixtime thread_id: - description: The [thread](https://platform.openai.com/docs/api-reference/threads) ID that this message belongs to. + description: The [thread](https://developers.openai.com/api/docs/assistants/migration) ID that this message belongs to. type: string status: description: The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. @@ -41405,12 +41474,12 @@ components: $ref: '#/components/schemas/MessageContent' assistant_id: anyOf: - - description: If applicable, the ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) that authored this message. + - description: If applicable, the ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) that authored this message. type: string - type: 'null' run_id: anyOf: - - description: The ID of the [run](https://platform.openai.com/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. + - description: The ID of the [run](https://developers.openai.com/api/docs/assistants/migration) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints. type: string - type: 'null' attachments: @@ -41512,9 +41581,9 @@ components: required: - event - data - description: Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is created. + description: Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) is created. x-oaiMeta: - dataDescription: '`data` is a [message](/docs/api-reference/messages/object)' + dataDescription: '`data` is a [message](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -41527,9 +41596,9 @@ components: required: - event - data - description: Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) moves to an `in_progress` state. + description: Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) moves to an `in_progress` state. x-oaiMeta: - dataDescription: '`data` is a [message](/docs/api-reference/messages/object)' + dataDescription: '`data` is a [message](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -41542,9 +41611,9 @@ components: required: - event - data - description: Occurs when parts of a [Message](https://platform.openai.com/docs/api-reference/messages/object) are being streamed. + description: Occurs when parts of a [Message](https://developers.openai.com/api/docs/assistants/migration) are being streamed. x-oaiMeta: - dataDescription: '`data` is a [message delta](/docs/api-reference/assistants-streaming/message-delta-object)' + dataDescription: '`data` is a [message delta](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -41557,9 +41626,9 @@ components: required: - event - data - description: Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) is completed. + description: Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) is completed. x-oaiMeta: - dataDescription: '`data` is a [message](/docs/api-reference/messages/object)' + dataDescription: '`data` is a [message](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -41572,9 +41641,9 @@ components: required: - event - data - description: Occurs when a [message](https://platform.openai.com/docs/api-reference/messages/object) ends before it is completed. + description: Occurs when a [message](https://developers.openai.com/api/docs/assistants/migration) ends before it is completed. x-oaiMeta: - dataDescription: '`data` is a [message](/docs/api-reference/messages/object)' + dataDescription: '`data` is a [message](https://developers.openai.com/api/docs/assistants/migration)' discriminator: propertyName: event Metadata: @@ -41641,7 +41710,7 @@ components: - $ref: '#/components/schemas/ModelIdsResponses' - type: string - type: 'null' - description: Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models. + description: Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. ModelIdsResponses: example: gpt-6-astra anyOf: @@ -41722,7 +41791,7 @@ components: description: | This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. - Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). safety_identifier: anyOf: - type: string @@ -41730,14 +41799,14 @@ components: example: safety-identifier-1234 description: | A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). - type: 'null' prompt_cache_key: anyOf: - type: string example: prompt-cache-key-1234 description: | - Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching). - type: 'null' prompt_cache_retention: deprecated: true @@ -41749,7 +41818,7 @@ components: description: | Deprecated. Use `prompt_cache_options.ttl` instead. - The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). This field expresses a maximum retention policy, while `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields are independent and do not interact. @@ -41765,7 +41834,7 @@ components: properties: model: description: | - ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them. + ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them. anyOf: - type: string - $ref: '#/components/schemas/AssistantSupportedModels' @@ -41812,7 +41881,7 @@ components: file_ids: type: array description: | - Overrides the list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + Overrides the list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -41823,7 +41892,7 @@ components: vector_store_ids: type: array description: | - Overrides the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + Overrides the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. maxItems: 1 items: type: string @@ -41890,7 +41959,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -41901,7 +41970,7 @@ components: vector_store_ids: type: array description: | - The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. + The [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this thread. There can be a maximum of 1 vector store attached to the thread. maxItems: 1 items: type: string @@ -42403,7 +42472,7 @@ components: - $ref: '#/components/schemas/OutputTextContent' - $ref: '#/components/schemas/RefusalContent' ParallelToolCalls: - description: Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use. + description: Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use. type: boolean default: true PartialImages: @@ -42451,7 +42520,7 @@ components: The content used for a Predicted Output. This is often the text of a file you are regenerating with minor changes. - type: array - description: An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text inputs. + description: An array of content parts with a defined type. Supported options differ based on the [model](https://developers.openai.com/api/docs/models) being used to generate the response. Can contain text inputs. title: Array of content parts items: $ref: '#/components/schemas/ChatCompletionRequestMessageContentPartText' @@ -42533,6 +42602,12 @@ components: type: integer format: unixtime description: The Unix timestamp (in seconds) of when the API key was created + expires_at: + anyOf: + - type: integer + format: unixtime + - type: 'null' + description: The Unix timestamp (in seconds) when the API key expires, or null if it does not expire. last_used_at: anyOf: - type: integer @@ -42578,6 +42653,7 @@ components: "redacted_value": "sk-abc...def", "name": "My API Key", "created_at": 1711471533, + "expires_at": 1714063533, "last_used_at": 1711471534, "id": "key_abc", "owner_project_access": "active", @@ -42694,13 +42770,13 @@ components: - type: 'null' deprecated: true description: |- - Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. + Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. Deprecated: use `residency` instead. Do not provide both `geography` and `residency`. residency: anyOf: - $ref: '#/components/schemas/PublicProjectResidency' - type: 'null' - description: Create the project with the specified residency configuration. Your organization must have access to the requested residency configuration in order to use it. See [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. + description: Create the project with the specified residency configuration. Your organization must have access to the requested residency configuration in order to use it. See [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. external_key_id: anyOf: - type: string @@ -43180,6 +43256,12 @@ components: created_at: type: integer format: unixtime + expires_at: + anyOf: + - type: integer + format: unixtime + - type: 'null' + description: The Unix timestamp (in seconds) when the API key expires, or null if it does not expire. id: type: string required: @@ -43198,7 +43280,15 @@ components: anyOf: - type: boolean description: Create the service account without default roles or an API key. + example: false + - type: 'null' + expires_in_seconds: + anyOf: + - type: integer + minimum: 1 + maximum: 31536000 - type: 'null' + description: Number of seconds until the initial API key expires. If omitted or null, the key does not expire unless the effective organization or project policy requires an expiration. When a policy sets a maximum lifetime, this value must be provided and must not exceed that limit. A non-null value cannot be used when `create_service_account_only` is true. required: - name ProjectServiceAccountCreateResponse: @@ -43517,7 +43607,7 @@ components: - type: object description: | Reference to a prompt template and its variables. - [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code). required: - id properties: @@ -43894,7 +43984,7 @@ components: stop generating audio and emit a `output_audio_buffer.cleared` event. This event should be preceded by a `response.cancel` client event to stop the generation of the current response. - [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). + [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). properties: event_id: type: string @@ -46219,7 +46309,7 @@ components: - $ref: '#/components/schemas/RealtimeSessionCreateRequestGA' description: |- Optional session configuration to apply before the realtime session is - created. Use the same parameters you would send in a [`create client secret`](https://platform.openai.com/docs/api-reference/realtime-sessions/create-realtime-client-secret) + created. Use the same parameters you would send in a [`create client secret`](https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create) request. additionalProperties: false RealtimeCallReferRequest: @@ -46481,7 +46571,7 @@ components: stop generating audio and emit a `output_audio_buffer.cleared` event. This event should be preceded by a `response.cancel` client event to stop the generation of the current response. - [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). + [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). properties: event_id: type: string @@ -47065,7 +47155,7 @@ components: description: | Create a session and client secret for the Realtime API. The request can specify either a realtime or a transcription session configuration. - [Learn more about the Realtime API](https://platform.openai.com/docs/guides/realtime). + [Learn more about the Realtime API](https://developers.openai.com/api/docs/guides/realtime). properties: expires_after: type: object @@ -48621,7 +48711,7 @@ components: mode when the user has interrupted (`input_audio_buffer.speech_started`), or when the client has emitted the `output_audio_buffer.clear` event to manually cut off the current audio response. - [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). + [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). properties: event_id: type: string @@ -48652,7 +48742,7 @@ components: **WebRTC/SIP Only:** Emitted when the server begins streaming audio to the client. This event is emitted after an audio content part has been added (`response.content_part.added`) to the response. - [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). + [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). properties: event_id: type: string @@ -48683,7 +48773,7 @@ components: **WebRTC/SIP Only:** Emitted when the output audio buffer has been completely drained on the server, and no more audio is forthcoming. This event is emitted after the full response data has been sent to the client (`response.done`). - [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). + [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). properties: event_id: type: string @@ -50018,7 +50108,7 @@ components: - allOf: - $ref: '#/components/schemas/AudioTranscription' description: | - Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service. + Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service. - type: 'null' turn_detection: $ref: '#/components/schemas/RealtimeTurnDetection' @@ -50418,7 +50508,7 @@ components: description: The format of the input audio. transcription: description: | - Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service. + Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service. $ref: '#/components/schemas/AudioTranscription' noise_reduction: type: object @@ -51070,7 +51160,7 @@ components: $ref: '#/components/schemas/RealtimeAudioFormats' transcription: description: | - Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service. + Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service. $ref: '#/components/schemas/AudioTranscription' noise_reduction: type: object @@ -52128,7 +52218,7 @@ components: type: object description: | Configuration options for - [reasoning models](https://platform.openai.com/docs/guides/reasoning). + [reasoning models](https://developers.openai.com/api/docs/guides/reasoning). title: Reasoning properties: mode: @@ -52202,7 +52292,7 @@ components: Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the - [reasoning guide](https://platform.openai.com/docs/guides/reasoning) + [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specific support. - type: 'null' ReasoningItem: @@ -52211,7 +52301,7 @@ components: A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually - [managing context](https://platform.openai.com/docs/guides/conversation-state). + [managing context](https://developers.openai.com/api/docs/guides/conversation-state). title: Reasoning properties: type: @@ -52419,7 +52509,7 @@ components: max_output_tokens: anyOf: - description: | - An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning). type: integer - type: 'null' required: @@ -53414,7 +53504,7 @@ components: title: JSON schema description: | JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs). properties: type: type: string @@ -53449,7 +53539,7 @@ components: If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). + guide](https://developers.openai.com/api/docs/guides/structured-outputs). - type: 'null' required: - name @@ -53482,7 +53572,7 @@ components: title: Text grammar description: | A custom grammar for the model to follow when generating text. - Learn more in the [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars). + Learn more in the [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars). properties: type: type: string @@ -53501,7 +53591,7 @@ components: title: Python grammar description: | Configure the model to generate valid Python code. See the - [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars) for more details. + [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars) for more details. properties: type: type: string @@ -54275,7 +54365,7 @@ components: `["text"]` The `gpt-4o-audio-preview` model can also be used to - [generate audio](https://platform.openai.com/docs/guides/audio). To request that this model generate + [generate audio](https://developers.openai.com/api/docs/guides/audio). To request that this model generate both text and audio responses, you can use: `["text", "audio"]` @@ -54468,13 +54558,13 @@ components: description: | The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about - [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. - type: 'null' model: description: | Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance - characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. $ref: '#/components/schemas/ModelIdsResponses' background: @@ -54482,7 +54572,7 @@ components: - type: boolean description: | Whether to run the model response in the background. - [Learn more](https://platform.openai.com/docs/guides/background). + [Learn more](https://developers.openai.com/api/docs/guides/background). default: false - type: 'null' max_tool_calls: @@ -55686,8 +55776,8 @@ components: description: | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) - - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs) + - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) + - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs) properties: format: $ref: '#/components/schemas/TextResponseFormatConfiguration' @@ -55708,7 +55798,9 @@ components: properties: cached_tokens: type: integer - description: "The number of tokens that were retrieved from the cache. \n[More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).\n" + description: | + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching). cache_write_tokens: type: integer description: The number of input tokens that were written to the cache. @@ -56909,10 +57001,16 @@ components: propertyName: type item: type: object - description: "The dataset item provided to the grader. This will be used to populate \nthe `item` namespace. See [the guide](https://platform.openai.com/docs/guides/graders) for more details. \n" + description: | + The dataset item provided to the grader. This will be used to populate + the `item` namespace. See [the guide](https://developers.openai.com/api/docs/guides/graders) for more details. model_sample: type: string - description: "The model sample to be evaluated. This value will be used to populate \nthe `sample` namespace. See [the guide](https://platform.openai.com/docs/guides/graders) for more details.\nThe `output_json` variable will be populated if the model sample is a \nvalid JSON string.\n \n" + description: | + The model sample to be evaluated. This value will be used to populate + the `sample` namespace. See [the guide](https://developers.openai.com/api/docs/guides/graders) for more details. + The `output_json` variable will be populated if the model sample is a + valid JSON string. required: - grader - model_sample @@ -57015,7 +57113,7 @@ components: RunObject: type: object title: A run on a thread - description: Represents an execution run on a [thread](https://platform.openai.com/docs/api-reference/threads). + description: Represents an execution run on a [thread](https://developers.openai.com/api/docs/assistants/migration). properties: id: description: The identifier, which can be referenced in API endpoints. @@ -57031,10 +57129,10 @@ components: type: integer format: unixtime thread_id: - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was executed on as a part of this run. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) that was executed on as a part of this run. type: string assistant_id: - description: The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for execution of this run. + description: The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for execution of this run. type: string status: $ref: '#/components/schemas/RunStatus' @@ -57119,13 +57217,13 @@ components: - max_completion_tokens - max_prompt_tokens model: - description: The model that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. + description: The model that the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for this run. type: string instructions: - description: The instructions that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. + description: The instructions that the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for this run. type: string tools: - description: The list of tools that the [assistant](https://platform.openai.com/docs/api-reference/assistants) used for this run. + description: The list of tools that the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for this run. default: [] type: array maxItems: 20 @@ -57367,7 +57465,7 @@ components: type: object properties: file_id: - description: The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. + description: The [file](https://developers.openai.com/api/reference/resources/files) ID of the image. type: string required: - index @@ -57445,7 +57543,7 @@ components: output: anyOf: - type: string - description: The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. + description: The output of the function. This will be `null` if the outputs have not been [submitted](https://developers.openai.com/api/docs/assistants/migration) yet. - type: 'null' required: - index @@ -57543,7 +57641,7 @@ components: type: object properties: file_id: - description: The [file](https://platform.openai.com/docs/api-reference/files) ID of the image. + description: The [file](https://developers.openai.com/api/reference/resources/files) ID of the image. type: string required: - file_id @@ -57683,7 +57781,7 @@ components: output: anyOf: - type: string - description: The output of the function. This will be `null` if the outputs have not been [submitted](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) yet. + description: The output of the function. This will be `null` if the outputs have not been [submitted](https://developers.openai.com/api/docs/assistants/migration) yet. - type: 'null' required: - name @@ -57733,13 +57831,13 @@ components: type: integer format: unixtime assistant_id: - description: The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) associated with the run step. + description: The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) associated with the run step. type: string thread_id: - description: The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) that was run. + description: The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) that was run. type: string run_id: - description: The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that this run step is a part of. + description: The ID of the [run](https://developers.openai.com/api/docs/assistants/migration) that this run step is a part of. type: string type: description: The type of run step, which can be either `message_creation` or `tool_calls`. @@ -57871,9 +57969,9 @@ components: required: - event - data - description: Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is created. + description: Occurs when a [run step](https://developers.openai.com/api/docs/assistants/migration) is created. x-oaiMeta: - dataDescription: '`data` is a [run step](/docs/api-reference/run-steps/step-object)' + dataDescription: '`data` is a [run step](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -57886,9 +57984,9 @@ components: required: - event - data - description: Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) moves to an `in_progress` state. + description: Occurs when a [run step](https://developers.openai.com/api/docs/assistants/migration) moves to an `in_progress` state. x-oaiMeta: - dataDescription: '`data` is a [run step](/docs/api-reference/run-steps/step-object)' + dataDescription: '`data` is a [run step](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -57901,9 +57999,9 @@ components: required: - event - data - description: Occurs when parts of a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) are being streamed. + description: Occurs when parts of a [run step](https://developers.openai.com/api/docs/assistants/migration) are being streamed. x-oaiMeta: - dataDescription: '`data` is a [run step delta](/docs/api-reference/assistants-streaming/run-step-delta-object)' + dataDescription: '`data` is a [run step delta](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -57916,9 +58014,9 @@ components: required: - event - data - description: Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is completed. + description: Occurs when a [run step](https://developers.openai.com/api/docs/assistants/migration) is completed. x-oaiMeta: - dataDescription: '`data` is a [run step](/docs/api-reference/run-steps/step-object)' + dataDescription: '`data` is a [run step](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -57931,9 +58029,9 @@ components: required: - event - data - description: Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) fails. + description: Occurs when a [run step](https://developers.openai.com/api/docs/assistants/migration) fails. x-oaiMeta: - dataDescription: '`data` is a [run step](/docs/api-reference/run-steps/step-object)' + dataDescription: '`data` is a [run step](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -57946,9 +58044,9 @@ components: required: - event - data - description: Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) is cancelled. + description: Occurs when a [run step](https://developers.openai.com/api/docs/assistants/migration) is cancelled. x-oaiMeta: - dataDescription: '`data` is a [run step](/docs/api-reference/run-steps/step-object)' + dataDescription: '`data` is a [run step](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -57961,9 +58059,9 @@ components: required: - event - data - description: Occurs when a [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object) expires. + description: Occurs when a [run step](https://developers.openai.com/api/docs/assistants/migration) expires. x-oaiMeta: - dataDescription: '`data` is a [run step](/docs/api-reference/run-steps/step-object)' + dataDescription: '`data` is a [run step](https://developers.openai.com/api/docs/assistants/migration)' discriminator: propertyName: event RunStreamEvent: @@ -57980,9 +58078,9 @@ components: required: - event - data - description: Occurs when a new [run](https://platform.openai.com/docs/api-reference/runs/object) is created. + description: Occurs when a new [run](https://developers.openai.com/api/docs/assistants/migration) is created. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -57995,9 +58093,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `queued` status. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) moves to a `queued` status. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58010,9 +58108,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to an `in_progress` status. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) moves to an `in_progress` status. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58025,9 +58123,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `requires_action` status. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) moves to a `requires_action` status. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58040,9 +58138,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is completed. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) is completed. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58055,9 +58153,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) ends with status `incomplete`. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) ends with status `incomplete`. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58070,9 +58168,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) fails. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) fails. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58085,9 +58183,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) moves to a `cancelling` status. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) moves to a `cancelling` status. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58100,9 +58198,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) is cancelled. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) is cancelled. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' - type: object properties: event: @@ -58115,9 +58213,9 @@ components: required: - event - data - description: Occurs when a [run](https://platform.openai.com/docs/api-reference/runs/object) expires. + description: Occurs when a [run](https://developers.openai.com/api/docs/assistants/migration) expires. x-oaiMeta: - dataDescription: '`data` is a [run](/docs/api-reference/runs/object)' + dataDescription: '`data` is a [run](https://developers.openai.com/api/docs/assistants/migration)' discriminator: propertyName: event RunToolCallObject: @@ -58126,7 +58224,7 @@ components: properties: id: type: string - description: The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) endpoint. + description: The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](https://developers.openai.com/api/docs/assistants/migration) endpoint. type: type: string description: The type of tool call the output is required for. For now, this is always `function`. @@ -58157,8 +58255,8 @@ components: Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. + - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. + - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. @@ -58178,8 +58276,8 @@ components: Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. + - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. + - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`. - When not set, the default behavior is 'auto'. @@ -58382,7 +58480,20 @@ components: required: - tool_outputs TextResponseFormatConfiguration: - description: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n" + description: | + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. anyOf: - $ref: '#/components/schemas/ResponseFormatText' - $ref: '#/components/schemas/TextResponseFormatJsonSchema' @@ -58394,7 +58505,7 @@ components: title: JSON schema description: | JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs). properties: type: type: string @@ -58423,7 +58534,7 @@ components: If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). + guide](https://developers.openai.com/api/docs/guides/structured-outputs). - type: 'null' required: - type @@ -58432,7 +58543,7 @@ components: ThreadObject: type: object title: Thread - description: Represents a thread that contains [messages](https://platform.openai.com/docs/api-reference/messages). + description: Represents a thread that contains [messages](https://developers.openai.com/api/docs/assistants/migration). properties: id: description: The identifier, which can be referenced in API endpoints. @@ -58459,7 +58570,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -58470,7 +58581,7 @@ components: vector_store_ids: type: array description: | - The [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. + The [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this thread. There can be a maximum of 1 vector store attached to the thread. maxItems: 1 items: type: string @@ -58510,9 +58621,9 @@ components: required: - event - data - description: Occurs when a new [thread](https://platform.openai.com/docs/api-reference/threads/object) is created. + description: Occurs when a new [thread](https://developers.openai.com/api/docs/assistants/migration) is created. x-oaiMeta: - dataDescription: '`data` is a [thread](/docs/api-reference/threads/object)' + dataDescription: '`data` is a [thread](https://developers.openai.com/api/docs/assistants/migration)' discriminator: propertyName: event ToggleCertificatesRequest: @@ -58695,13 +58806,13 @@ components: title: Hosted tool description: | Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools). properties: type: type: string description: | The type of hosted tool the model should to use. Learn more about - [built-in tools](https://platform.openai.com/docs/guides/tools). + [built-in tools](https://developers.openai.com/api/docs/guides/tools). Allowed values are: - `file_search` @@ -58730,22 +58841,22 @@ components: We support the following categories of tools: - **Built-in tools**: Tools that are provided by OpenAI that extend the - model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) - or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about - [built-in tools](https://platform.openai.com/docs/guides/tools). + model's capabilities, like [web search](https://developers.openai.com/api/docs/guides/tools-web-search) + or [file search](https://developers.openai.com/api/docs/guides/tools-file-search). Learn more about + [built-in tools](https://developers.openai.com/api/docs/guides/tools). - **MCP Tools**: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about - [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp). - **Function calls (custom tools)**: Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about - [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + [function calling](https://developers.openai.com/api/docs/guides/function-calling). You can also use custom tools to call your own code. items: $ref: '#/components/schemas/Tool' TranscriptTextDeltaEvent: type: object - description: Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`. + description: Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with the `Stream` parameter set to `true`. properties: type: type: string @@ -58761,7 +58872,7 @@ components: logprobs: type: array description: | - The log probabilities of the delta. Only included if you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`. + The log probabilities of the delta. Only included if you [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with the `include[]` parameter set to `logprobs`. items: type: object properties: @@ -58796,7 +58907,7 @@ components: } TranscriptTextDoneEvent: type: object - description: Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`. + description: Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with the `Stream` parameter set to `true`. properties: type: type: string @@ -58818,7 +58929,7 @@ components: logprobs: type: array description: | - The log probabilities of the individual tokens in the transcription. Only included if you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`. + The log probabilities of the individual tokens in the transcription. Only included if you [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with the `include[]` parameter set to `logprobs`. items: type: object properties: @@ -58862,7 +58973,7 @@ components: TranscriptTextSegmentEvent: type: object description: | - Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with `stream` set to `true` and `response_format` set to `diarized_json`. + Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with `stream` set to `true` and `response_format` set to `diarized_json`. properties: type: type: string @@ -59224,7 +59335,7 @@ components: description: The intended number of bytes to be uploaded. purpose: type: string - description: The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values. + description: The intended purpose of the file. [Please refer here](https://developers.openai.com/api/reference/resources/files#%28resource%29%20files%20%3E%20%28model%29%20file_object%20%3E%20%28schema%29%20%3E%20%28property%29%20purpose) for acceptable values. status: type: string description: The status of the Upload. @@ -60338,7 +60449,7 @@ components: type: integer format: unixtime vector_store_id: - description: The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) that the [File](https://platform.openai.com/docs/api-reference/files) is attached to. + description: The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) that the [File](https://developers.openai.com/api/reference/resources/files) is attached to. type: string status: description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. @@ -60454,7 +60565,7 @@ components: type: integer format: unixtime vector_store_id: - description: The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) that the [File](https://platform.openai.com/docs/api-reference/files) is attached to. + description: The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) that the [File](https://developers.openai.com/api/reference/resources/files) is attached to. type: string status: description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. @@ -61117,7 +61228,7 @@ components: title: Web search description: | Search the Internet for sources related to the prompt. Learn more about the - [web search tool](https://platform.openai.com/docs/guides/tools-web-search). + [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search). properties: type: type: string @@ -61168,7 +61279,7 @@ components: title: Web search tool call description: | The results of a web search tool call. See the - [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information. + [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information. properties: id: type: string @@ -61761,7 +61872,9 @@ components: sip_headers: type: array description: | - Headers from the SIP Invite. + Headers from the SIP INVITE, excluding SIP authorization headers. + Retained names, values, repeated entries, and order are preserved. + Treat these values as untrusted call metadata. items: type: object description: | @@ -61803,9 +61916,9 @@ components: "data": { "session_id": "live_u0_479a275623b54bdb9b6fbae2f7cbd408", "sip_headers": [ - {"name": "Max-Forwards", "value": "63"}, - {"name": "CSeq", "value": "851287 INVITE"}, - {"name": "Content-Type", "value": "application/sdp"}, + {"name": "From", "value": ";tag=abc123"}, + {"name": "To", "value": ""}, + {"name": "Call-ID", "value": "call-123@example.com"} ] } } @@ -61849,7 +61962,9 @@ components: sip_headers: type: array description: | - Headers from the SIP Invite. + Headers from the SIP INVITE, excluding SIP authorization headers. + Retained names, values, repeated entries, and order are preserved. + Treat these values as untrusted call metadata. items: type: object description: | @@ -61893,7 +62008,7 @@ components: "sip_headers": [ {"name": "Max-Forwards", "value": "63"}, {"name": "CSeq", "value": "851287 INVITE"}, - {"name": "Content-Type", "value": "application/sdp"}, + {"name": "Content-Type", "value": "application/sdp"} ] } } @@ -62297,7 +62412,7 @@ components: type: object required: [] title: Prompt cache options - description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details. + description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details. PromptCacheBreakpointParam: properties: mode: @@ -62829,7 +62944,7 @@ components: - type - detail title: Input image - description: An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + description: An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision). ComputerScreenshotContent: properties: type: @@ -63048,6 +63163,24 @@ components: - completed - failed - incomplete + ImageGenActionEnum: + type: string + enum: + - generate + - edit + - auto + ImageBackground: + type: string + enum: + - transparent + - opaque + - auto + ImageOutputFormat: + type: string + enum: + - png + - webp + - jpeg ClickButtonType: type: string enum: @@ -63426,7 +63559,7 @@ components: - strict - parameters title: Function - description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). + description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://developers.openai.com/api/docs/guides/function-calling). RankerVersionType: type: string enum: @@ -63491,7 +63624,7 @@ components: - type - vector_store_ids title: File search - description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search). + description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search). ComputerTool: properties: type: @@ -63505,7 +63638,7 @@ components: required: - type title: Computer - description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use). ComputerEnvironment: type: string enum: @@ -63539,7 +63672,7 @@ components: - display_width - display_height title: Computer use preview - description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use). ContainerMemoryLimit: type: string enum: @@ -63577,12 +63710,6 @@ components: - high - low description: Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`. - ImageGenActionEnum: - type: string - enum: - - generate - - edit - - auto LocalShellToolParam: properties: type: @@ -63802,7 +63929,7 @@ components: - type - name title: Custom tool - description: A custom tool that processes input using a specified format. Learn more about [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools) + description: A custom tool that processes input using a specified format. Learn more about [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools) EmptyModelParam: properties: {} type: object @@ -63989,7 +64116,7 @@ components: required: - type title: Web search preview - description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). + description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search). ApplyPatchToolParam: properties: type: @@ -64162,7 +64289,7 @@ components: - id - encrypted_content title: Compaction item - description: A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + description: A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact). CodeInterpreterOutputLogs: properties: type: @@ -64782,7 +64909,7 @@ components: required: - type title: Input image - description: An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + description: An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision) FileDetailEnum: type: string enum: @@ -65127,7 +65254,7 @@ components: - type - encrypted_content title: Compaction item - description: A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + description: A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact). FunctionShellActionParam: properties: commands: @@ -65766,7 +65893,7 @@ components: type: object required: [] title: Prompt cache options - description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details. + description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details. ReasoningModeEnum: anyOf: - type: string @@ -66963,7 +67090,7 @@ components: model: anyOf: - type: string - description: Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models. + description: Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. - type: 'null' input: anyOf: @@ -66981,7 +67108,7 @@ components: previous_response_id: anyOf: - type: string - description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. example: resp_123 - type: 'null' tools: @@ -66998,7 +67125,7 @@ components: reasoning: anyOf: - $ref: '#/components/schemas/Reasoning' - description: '**gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).' + description: '**gpt-5 and o-series models only** Configuration options for [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).' - type: 'null' truncation: $ref: '#/components/schemas/TruncationEnum' @@ -67081,7 +67208,7 @@ components: previous_response_id: anyOf: - type: string - description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. example: resp_123 - type: 'null' instructions: @@ -67111,7 +67238,7 @@ components: anyOf: - $ref: '#/components/schemas/ServiceTierEnum' description: |- - Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'. + Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - type: 'null' type: object @@ -68565,7 +68692,7 @@ components: model: anyOf: - type: string - description: Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models. + description: Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. - type: 'null' input: anyOf: @@ -68583,7 +68710,7 @@ components: previous_response_id: anyOf: - type: string - description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. example: resp_123 - type: 'null' tools: @@ -68600,7 +68727,7 @@ components: reasoning: anyOf: - $ref: '#/components/schemas/BetaReasoning' - description: '**gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).' + description: '**gpt-5 and o-series models only** Configuration options for [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).' - type: 'null' truncation: $ref: '#/components/schemas/BetaTruncationEnum' @@ -68753,13 +68880,13 @@ components: title: Hosted tool description: | Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). + [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools). properties: type: type: string description: | The type of hosted tool the model should to use. Learn more about - [built-in tools](https://platform.openai.com/docs/guides/tools). + [built-in tools](https://developers.openai.com/api/docs/guides/tools). Allowed values are: - `file_search` @@ -68880,7 +69007,7 @@ components: type: object description: | Configuration options for - [reasoning models](https://platform.openai.com/docs/guides/reasoning). + [reasoning models](https://developers.openai.com/api/docs/guides/reasoning). title: Reasoning properties: mode: @@ -68954,7 +69081,7 @@ components: Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the - [reasoning guide](https://platform.openai.com/docs/guides/reasoning) + [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specific support. - type: 'null' BetaReasoningModeEnum: @@ -68969,8 +69096,8 @@ components: description: | Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) - - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs) + - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) + - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs) properties: format: $ref: '#/components/schemas/BetaTextResponseFormatConfiguration' @@ -68991,7 +69118,20 @@ components: `medium`. - type: 'null' BetaTextResponseFormatConfiguration: - description: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n" + description: | + An object specifying the format that the model must output. + + Configuring `{ "type": "json_schema" }` enables Structured Outputs, + which ensures the model will match your supplied JSON schema. Learn more in the + [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). + + The default format is `{ "type": "text" }` with no additional options. + + **Not recommended for gpt-4o and newer models:** + + Setting to `{ "type": "json_object" }` enables the older JSON mode, which + ensures the message the model generates is valid JSON. Using `json_schema` + is preferred for models that support it. anyOf: - $ref: '#/components/schemas/BetaResponseFormatText' - $ref: '#/components/schemas/BetaTextResponseFormatJsonSchema' @@ -69020,7 +69160,7 @@ components: title: JSON schema description: | JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs). properties: type: type: string @@ -69049,7 +69189,7 @@ components: If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs - guide](https://platform.openai.com/docs/guides/structured-outputs). + guide](https://developers.openai.com/api/docs/guides/structured-outputs). - type: 'null' required: - type @@ -69151,7 +69291,7 @@ components: required: - type title: Web search preview - description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). + description: This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search). BetaSearchContentType: type: string enum: @@ -69307,7 +69447,7 @@ components: - type - name title: Custom tool - description: A custom tool that processes input using a specified format. Learn more about [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools) + description: A custom tool that processes input using a specified format. Learn more about [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools) BetaCustomGrammarFormatParam: properties: type: @@ -69907,7 +70047,7 @@ components: title: MCP tool description: | Give the model access to additional tools via remote Model Context Protocol - (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp). + (MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp). properties: type: type: string @@ -69939,7 +70079,7 @@ components: description: | Identifier for service connectors, like those available in ChatGPT. One of `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more - about service connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors). + about service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors). Currently supported `connector_id` values are: @@ -70055,7 +70195,7 @@ components: title: Web search description: | Search the Internet for sources related to the prompt. Learn more about the - [web search tool](https://platform.openai.com/docs/guides/tools-web-search). + [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search). properties: type: type: string @@ -70161,7 +70301,7 @@ components: - display_width - display_height title: Computer use preview - description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use). BetaComputerEnvironment: type: string enum: @@ -70183,7 +70323,7 @@ components: required: - type title: Computer - description: A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). + description: A tool that controls a virtual computer. Learn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use). BetaFileSearchTool: properties: type: @@ -70214,7 +70354,7 @@ components: - type - vector_store_ids title: File search - description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search). + description: A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search). BetaFilters: anyOf: - $ref: '#/components/schemas/BetaComparisonFilter' @@ -70378,7 +70518,7 @@ components: - strict - parameters title: Function - description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). + description: Defines a function in your own code the model can choose to call. Learn more about [function calling](https://developers.openai.com/api/docs/guides/function-calling). BetaInputItem: discriminator: propertyName: type @@ -70800,7 +70940,7 @@ components: - type - detail title: Input image - description: An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + description: An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision). BetaImageDetail: type: string enum: @@ -71806,11 +71946,43 @@ components: - auto - type: 'null' description: The quality of the image generated by the image generation tool call. One of `low`, `medium`, `high`, `xhigh`, `max`, or `auto`. + action: + anyOf: + - $ref: '#/components/schemas/BetaImageGenActionEnum' + - type: 'null' + description: The action used for image generation. + background: + anyOf: + - $ref: '#/components/schemas/BetaImageBackground' + - type: 'null' + description: The background setting used for generation. + output_format: + anyOf: + - $ref: '#/components/schemas/BetaImageOutputFormat' + - type: 'null' + description: The output format used for generation. + revised_prompt: + anyOf: + - type: string + - type: 'null' + description: The prompt that was used after any model prompt rewriting. required: - type - id - status - result + BetaImageOutputFormat: + type: string + enum: + - png + - webp + - jpeg + BetaImageBackground: + type: string + enum: + - transparent + - opaque + - auto BetaCompactionSummaryItemParam: properties: agent: @@ -71840,14 +72012,14 @@ components: - type - encrypted_content title: Compaction item - description: A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + description: A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact). BetaReasoningItem: type: object description: | A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually - [managing context](https://platform.openai.com/docs/guides/conversation-state). + [managing context](https://developers.openai.com/api/docs/guides/conversation-state). title: Reasoning properties: agent: @@ -72414,7 +72586,7 @@ components: required: - type title: Input image - description: An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) + description: An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision) BetaPromptCacheBreakpointParam: properties: mode: @@ -72586,7 +72758,9 @@ components: BetaFunctionToolCall: type: object title: Function tool call - description: "A tool call to run a function. See the \n[function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information.\n" + description: | + A tool call to run a function. See the + [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information. properties: agent: anyOf: @@ -72647,7 +72821,7 @@ components: title: Web search tool call description: | The results of a web search tool call. See the - [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information. + [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information. properties: agent: anyOf: @@ -72887,7 +73061,7 @@ components: title: Computer tool call description: | A tool call to a computer use tool. See the - [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information. + [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information. properties: agent: anyOf: @@ -73210,7 +73384,7 @@ components: title: File search tool call description: | The results of a file search tool call. See the - [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information. + [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information. properties: agent: anyOf: @@ -73698,7 +73872,7 @@ components: previous_response_id: anyOf: - type: string - description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + description: The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. example: resp_123 - type: 'null' instructions: @@ -73728,7 +73902,7 @@ components: anyOf: - $ref: '#/components/schemas/BetaServiceTierEnum' description: |- - Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'. + Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. - type: 'null' type: object @@ -73753,7 +73927,7 @@ components: type: object required: [] title: Prompt cache options - description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details. + description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details. BetaPromptCacheModeEnum: type: string enum: @@ -73773,7 +73947,7 @@ components: - $ref: '#/components/schemas/BetaModelIdsResponses' - type: string - type: 'null' - description: Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models. + description: Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. BetaModelIdsResponses: example: gpt-6-astra anyOf: @@ -74457,7 +74631,7 @@ components: - id - encrypted_content title: Compaction item - description: A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). + description: A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact). BetaProgramOutput: properties: agent: @@ -75111,7 +75285,9 @@ components: properties: cached_tokens: type: integer - description: "The number of tokens that were retrieved from the cache. \n[More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).\n" + description: | + The number of tokens that were retrieved from the cache. + [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching). cache_write_tokens: type: integer description: The number of input tokens that were written to the cache. @@ -75527,7 +75703,7 @@ components: max_output_tokens: anyOf: - description: | - An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning). type: integer - type: 'null' required: @@ -75830,8 +76006,8 @@ components: Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. + - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. + - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`. - When not set, the default behavior is 'auto'. @@ -75855,13 +76031,13 @@ components: description: | The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about - [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. + [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. - type: 'null' model: description: | Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance - characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) + characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models. $ref: '#/components/schemas/BetaModelIdsResponses' background: @@ -75869,7 +76045,7 @@ components: - type: boolean description: | Whether to run the model response in the background. - [Learn more](https://platform.openai.com/docs/guides/background). + [Learn more](https://developers.openai.com/api/docs/guides/background). default: false - type: 'null' max_tool_calls: @@ -75891,7 +76067,7 @@ components: - type: object description: | Reference to a prompt template and its variables. - [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). + [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code). required: - id properties: @@ -75933,16 +76109,16 @@ components: We support the following categories of tools: - **Built-in tools**: Tools that are provided by OpenAI that extend the - model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search) - or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about - [built-in tools](https://platform.openai.com/docs/guides/tools). + model's capabilities, like [web search](https://developers.openai.com/api/docs/guides/tools-web-search) + or [file search](https://developers.openai.com/api/docs/guides/tools-file-search). Learn more about + [built-in tools](https://developers.openai.com/api/docs/guides/tools). - **MCP Tools**: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about - [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp). + [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp). - **Function calls (custom tools)**: Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about - [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use + [function calling](https://developers.openai.com/api/docs/guides/function-calling). You can also use custom tools to call your own code. items: $ref: '#/components/schemas/BetaTool' @@ -75995,7 +76171,7 @@ components: description: | This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. - Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). safety_identifier: anyOf: - type: string @@ -76003,14 +76179,14 @@ components: example: safety-identifier-1234 description: | A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. - The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers). + The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers). - type: 'null' prompt_cache_key: anyOf: - type: string example: prompt-cache-key-1234 description: | - Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching). + Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching). - type: 'null' prompt_cache_retention: deprecated: true @@ -76022,7 +76198,7 @@ components: description: | Deprecated. Use `prompt_cache_options.ttl` instead. - The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention). + The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). This field expresses a maximum retention policy, while `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields are independent and do not interact. @@ -79408,11 +79584,11 @@ components: Text, image, or file inputs to the model, used to generate a response. Learn more: - - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) - - [Image inputs](https://platform.openai.com/docs/guides/images) - - [File inputs](https://platform.openai.com/docs/guides/pdf-files) - - [Conversation state](https://platform.openai.com/docs/guides/conversation-state) - - [Function calling](https://platform.openai.com/docs/guides/function-calling) + - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) + - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision) + - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs) + - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state) + - [Function calling](https://developers.openai.com/api/docs/guides/function-calling) anyOf: - type: string title: Text input @@ -80591,7 +80767,7 @@ components: Whether to store the generated model response for later retrieval via API. Defaults to true when omitted. - If set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](/api/docs/guides/your-data#v1responses). + If set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses). default: true - type: 'null' instructions: @@ -80615,7 +80791,7 @@ components: - description: | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). - See the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming) + See the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events) for more information. type: boolean default: false @@ -80638,7 +80814,7 @@ components: max_output_tokens: anyOf: - description: | - An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning). + An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning). type: integer minimum: 16 - type: 'null' @@ -80753,7 +80929,7 @@ components: type: object required: [] title: Prompt cache options - description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details. + description: Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details. BetaCreateModelResponseProperties: allOf: - $ref: '#/components/schemas/BetaModelResponseProperties' @@ -81094,12 +81270,12 @@ components: additionalProperties: false properties: assistant_id: - description: The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run. + description: The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run. type: string thread: $ref: '#/components/schemas/CreateThreadRequest' model: - description: The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + description: The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. nullable: true anyOf: - type: string @@ -81166,7 +81342,7 @@ components: file_ids: type: array description: | - A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + A list of [file](https://developers.openai.com/api/reference/resources/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. default: [] maxItems: 20 items: @@ -81177,7 +81353,7 @@ components: vector_store_ids: type: array description: | - The ID of the [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. maxItems: 1 items: type: string @@ -81236,10 +81412,10 @@ components: additionalProperties: false properties: assistant_id: - description: The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run. + description: The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run. type: string model: - description: The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + description: The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. nullable: true anyOf: - type: string @@ -81248,7 +81424,7 @@ components: reasoning_effort: $ref: '#/components/schemas/ReasoningEffort' instructions: - description: Overrides the [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis. + description: Overrides the [instructions](https://developers.openai.com/api/docs/assistants/migration) of the assistant. This is useful for modifying the behavior on a per-run basis. type: string nullable: true additional_instructions: @@ -81489,12 +81665,12 @@ x-oaiMeta: - id: responses-streaming title: Streaming events description: | - When you [create a Response](https://platform.openai.com/docs/api-reference/responses/create) with + When you [create a Response](https://developers.openai.com/api/reference/resources/responses/methods/create) with `stream` set to `true`, the server will emit server-sent events to the client as the Response is generated. This section contains the events that are emitted by the server. - [Learn more about streaming responses](https://platform.openai.com/docs/guides/streaming-responses?api-mode=responses). + [Learn more about streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses). navigationGroup: responses sections: - type: object @@ -81675,7 +81851,7 @@ x-oaiMeta: title: Server events description: | These events use the same payloads over WebSocket and - [HTTP streaming](./streaming-events). + [HTTP streaming](https://developers.openai.com/api/reference/resources/responses/streaming-events). navigationGroup: responses sections: - type: object @@ -81844,7 +82020,7 @@ x-oaiMeta: Webhooks are HTTP requests sent by OpenAI to a URL you specify when certain events happen during the course of API usage. - [Learn more about webhooks](https://platform.openai.com/docs/guides/webhooks). + [Learn more about webhooks](https://developers.openai.com/api/docs/guides/webhooks). navigationGroup: webhooks sections: - type: object @@ -81905,7 +82081,7 @@ x-oaiMeta: title: Image Streaming description: | Stream image generation and editing in real time with server-sent events. - [Learn more about image streaming](https://platform.openai.com/docs/guides/image-generation). + [Learn more about image streaming](https://developers.openai.com/api/docs/guides/image-generation). navigationGroup: endpoints sections: - type: object @@ -82144,7 +82320,7 @@ x-oaiMeta: description: | Stream Chat Completions in real time. Receive chunks of completions returned from the model using server-sent events. - [Learn more](https://platform.openai.com/docs/guides/streaming-responses?api-mode=chat). + [Learn more](https://developers.openai.com/api/docs/guides/streaming-responses). navigationGroup: chat sections: - type: object @@ -82155,11 +82331,11 @@ x-oaiMeta: beta: true description: | Stream the result of executing a Run or resuming a Run after submitting tool outputs. - You can stream events from the [Create Thread and Run](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun), - [Create Run](https://platform.openai.com/docs/api-reference/runs/createRun), and [Submit Tool Outputs](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) + You can stream events from the [Create Thread and Run](https://developers.openai.com/api/docs/assistants/migration), + [Create Run](https://developers.openai.com/api/docs/assistants/migration), and [Submit Tool Outputs](https://developers.openai.com/api/docs/assistants/migration) endpoints by passing `"stream": true`. The response will be a [Server-Sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) stream. Our Node and Python SDKs provide helpful utilities to make streaming easy. Reference the - [Assistants API quickstart](https://platform.openai.com/docs/assistants/overview) to learn more. + [Assistants API quickstart](https://developers.openai.com/api/docs/assistants/migration) to learn more. navigationGroup: assistants sections: - type: object diff --git a/pkg/cmd/adminorganizationauditlog.go b/pkg/cmd/adminorganizationauditlog.go index 61b9f138..c213b9f7 100644 --- a/pkg/cmd/adminorganizationauditlog.go +++ b/pkg/cmd/adminorganizationauditlog.go @@ -46,7 +46,7 @@ var adminOrganizationAuditLogsList = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[[]string]{ Name: "event-type", - Usage: "Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).", + Usage: "Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).", QueryPath: "event_types", }, &requestflag.Flag[int64]{ diff --git a/pkg/cmd/adminorganizationproject.go b/pkg/cmd/adminorganizationproject.go index 1c5776b6..0d3f8af8 100644 --- a/pkg/cmd/adminorganizationproject.go +++ b/pkg/cmd/adminorganizationproject.go @@ -32,7 +32,7 @@ var adminOrganizationProjectsCreate = cli.Command{ }, &requestflag.Flag[*string]{ Name: "geography", - Usage: "Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.\nDeprecated: use `residency` instead. Do not provide both `geography` and `residency`.", + Usage: "Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.\nDeprecated: use `residency` instead. Do not provide both `geography` and `residency`.", BodyPath: "geography", }, &requestflag.Flag[*string]{ diff --git a/pkg/cmd/adminorganizationprojectserviceaccount.go b/pkg/cmd/adminorganizationprojectserviceaccount.go index 65b65c40..3d8cbd9f 100644 --- a/pkg/cmd/adminorganizationprojectserviceaccount.go +++ b/pkg/cmd/adminorganizationprojectserviceaccount.go @@ -35,6 +35,11 @@ var adminOrganizationProjectsServiceAccountsCreate = cli.Command{ Usage: "Create the service account without default roles or an API key.", BodyPath: "create_service_account_only", }, + &requestflag.Flag[*int64]{ + Name: "expires-in-seconds", + Usage: "Number of seconds until the initial API key expires. If omitted or null, the key does not expire unless the effective organization or project policy requires an expiration. When a policy sets a maximum lifetime, this value must be provided and must not exceed that limit. A non-null value cannot be used when `create_service_account_only` is true.", + BodyPath: "expires_in_seconds", + }, }, Action: handleAdminOrganizationProjectsServiceAccountsCreate, HideHelpCommand: true, diff --git a/pkg/cmd/adminorganizationprojectserviceaccount_test.go b/pkg/cmd/adminorganizationprojectserviceaccount_test.go index a4cf1652..c3e995f8 100644 --- a/pkg/cmd/adminorganizationprojectserviceaccount_test.go +++ b/pkg/cmd/adminorganizationprojectserviceaccount_test.go @@ -17,7 +17,8 @@ func TestAdminOrganizationProjectsServiceAccountsCreate(t *testing.T) { "admin:organization:projects:service-accounts", "create", "--project-id", "project_id", "--name", "name", - "--create-service-account-only=true", + "--create-service-account-only=false", + "--expires-in-seconds", "1", ) }) @@ -25,7 +26,8 @@ func TestAdminOrganizationProjectsServiceAccountsCreate(t *testing.T) { // Test piping YAML data over stdin pipeData := []byte("" + "name: name\n" + - "create_service_account_only: true\n") + "create_service_account_only: false\n" + + "expires_in_seconds: 1\n") mocktest.TestRunMockTestWithPipeAndFlags( t, pipeData, "--api-key", "string", diff --git a/pkg/cmd/audiospeech.go b/pkg/cmd/audiospeech.go index ee892623..ab05775b 100644 --- a/pkg/cmd/audiospeech.go +++ b/pkg/cmd/audiospeech.go @@ -26,13 +26,13 @@ var audioSpeechCreate = cli.Command{ }, &requestflag.Flag[string]{ Name: "model", - Usage: "One of the available [TTS models](https://platform.openai.com/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.\n", + Usage: "One of the available [TTS models](https://developers.openai.com/api/docs/guides/text-to-speech): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.\n", Required: true, BodyPath: "model", }, &requestflag.Flag[any]{ Name: "voice", - Usage: "The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ \"id\": \"voice_1234\" }`. Previews of the voices are available in the [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).", + Usage: "The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ \"id\": \"voice_1234\" }`. Previews of the voices are available in the [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).", Required: true, BodyPath: "voice", }, diff --git a/pkg/cmd/audiotranscription.go b/pkg/cmd/audiotranscription.go index 74c18112..10d079d1 100644 --- a/pkg/cmd/audiotranscription.go +++ b/pkg/cmd/audiotranscription.go @@ -69,7 +69,7 @@ var audioTranscriptionsCreate = cli.Command{ }, &requestflag.Flag[string]{ Name: "prompt", - Usage: "An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-diarize`.\n", + Usage: "An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-diarize`.\n", BodyPath: "prompt", }, &requestflag.Flag[string]{ @@ -80,7 +80,7 @@ var audioTranscriptionsCreate = cli.Command{ }, &requestflag.Flag[*bool]{ Name: "stream", - Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)\nfor more information.\n\nNote: Streaming is not supported for the `whisper-1` model and will be ignored.\n", + Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section of the Speech-to-Text guide](https://developers.openai.com/api/docs/guides/speech-to-text?lang=curl#streaming)\nfor more information.\n\nNote: Streaming is not supported for the `whisper-1` model and will be ignored.\n", Default: requestflag.Ptr[bool](false), BodyPath: "stream", }, diff --git a/pkg/cmd/audiotranslation.go b/pkg/cmd/audiotranslation.go index 1f18e4c4..997954d3 100644 --- a/pkg/cmd/audiotranslation.go +++ b/pkg/cmd/audiotranslation.go @@ -34,7 +34,7 @@ var audioTranslationsCreate = cli.Command{ }, &requestflag.Flag[string]{ Name: "prompt", - Usage: "An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting) should be in English.\n", + Usage: "An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting) should be in English.\n", BodyPath: "prompt", }, &requestflag.Flag[string]{ diff --git a/pkg/cmd/batch.go b/pkg/cmd/batch.go index de28ac8b..b7b6048a 100644 --- a/pkg/cmd/batch.go +++ b/pkg/cmd/batch.go @@ -33,7 +33,7 @@ var batchesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "input-file-id", - Usage: "The ID of an uploaded file that contains requests for the new batch.\n\nSee [upload file](https://platform.openai.com/docs/api-reference/files/create) for how to upload a file.\n\nYour input file must be formatted as a [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size.\n", + Usage: "The ID of an uploaded file that contains requests for the new batch.\n\nSee [upload file](https://developers.openai.com/api/reference/resources/files/methods/create) for how to upload a file.\n\nYour input file must be formatted as a [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size.\n", Required: true, BodyPath: "input_file_id", }, diff --git a/pkg/cmd/betaassistant.go b/pkg/cmd/betaassistant.go index 08daefbe..02a3b3fb 100644 --- a/pkg/cmd/betaassistant.go +++ b/pkg/cmd/betaassistant.go @@ -21,7 +21,7 @@ var betaAssistantsCreate = requestflag.WithInnerFlags(cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[string]{ Name: "model", - Usage: "ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them.\n", + Usage: "ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.\n", Required: true, BodyPath: "model", }, @@ -47,13 +47,13 @@ var betaAssistantsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "reasoning-effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", Default: requestflag.Ptr[string]("medium"), BodyPath: "reasoning_effort", }, &requestflag.Flag[any]{ Name: "response-format", - Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o), [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", BodyPath: "response_format", }, &requestflag.Flag[*float64]{ @@ -137,7 +137,7 @@ var betaAssistantsUpdate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "model", - Usage: "ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them.\n", + Usage: "ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.\n", BodyPath: "model", }, &requestflag.Flag[*string]{ @@ -147,13 +147,13 @@ var betaAssistantsUpdate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "reasoning-effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", Default: requestflag.Ptr[string]("medium"), BodyPath: "reasoning_effort", }, &requestflag.Flag[any]{ Name: "response-format", - Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o), [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", BodyPath: "response_format", }, &requestflag.Flag[*float64]{ diff --git a/pkg/cmd/betaresponse.go b/pkg/cmd/betaresponse.go index 73a9bc95..30b7768f 100644 --- a/pkg/cmd/betaresponse.go +++ b/pkg/cmd/betaresponse.go @@ -16,12 +16,12 @@ import ( var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ Name: "create", - Usage: "Creates a model response. Provide\n[text](https://platform.openai.com/docs/guides/text) or\n[image](https://platform.openai.com/docs/guides/images) inputs to generate\n[text](https://platform.openai.com/docs/guides/text) or\n[JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have\nthe model call your own\n[custom code](https://platform.openai.com/docs/guides/function-calling) or use\nbuilt-in [tools](https://platform.openai.com/docs/guides/tools) like\n[web search](https://platform.openai.com/docs/guides/tools-web-search) or\n[file search](https://platform.openai.com/docs/guides/tools-file-search) to use\nyour own data as input for the model's response.", + Usage: "Creates a model response. Provide\n[text](https://developers.openai.com/api/docs/guides/text) or\n[image](https://developers.openai.com/api/docs/guides/images-vision) inputs to\ngenerate [text](https://developers.openai.com/api/docs/guides/text) or\n[JSON](https://developers.openai.com/api/docs/guides/structured-outputs)\noutputs. Have the model call your own\n[custom code](https://developers.openai.com/api/docs/guides/function-calling) or\nuse built-in [tools](https://developers.openai.com/api/docs/guides/tools) like\n[web search](https://developers.openai.com/api/docs/guides/tools-web-search) or\n[file search](https://developers.openai.com/api/docs/guides/tools-file-search)\nto use your own data as input for the model's response.", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[*bool]{ Name: "background", - Usage: "Whether to run the model response in the background.\n[Learn more](https://platform.openai.com/docs/guides/background).\n", + Usage: "Whether to run the model response in the background.\n[Learn more](https://developers.openai.com/api/docs/guides/background).\n", Default: requestflag.Ptr[bool](false), BodyPath: "background", }, @@ -42,7 +42,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[any]{ Name: "input", - Usage: "Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](https://platform.openai.com/docs/guides/text)\n- [Image inputs](https://platform.openai.com/docs/guides/images)\n- [File inputs](https://platform.openai.com/docs/guides/pdf-files)\n- [Conversation state](https://platform.openai.com/docs/guides/conversation-state)\n- [Function calling](https://platform.openai.com/docs/guides/function-calling)\n", + Usage: "Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)\n- [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)\n- [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)\n- [Function calling](https://developers.openai.com/api/docs/guides/function-calling)\n", BodyPath: "input", }, &requestflag.Flag[*string]{ @@ -52,7 +52,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*int64]{ Name: "max-output-tokens", - Usage: "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).\n", + Usage: "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).\n", BodyPath: "max_output_tokens", }, &requestflag.Flag[*int64]{ @@ -67,7 +67,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "model", - Usage: "Model ID used to generate the response, like `gpt-6-astra`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models)\nto browse and compare available models.\n", + Usage: "Model ID used to generate the response, like `gpt-6-astra`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models)\nto browse and compare available models.\n", BodyPath: "model", }, &requestflag.Flag[map[string]any]{ @@ -88,54 +88,54 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "previous-response-id", - Usage: "The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.\n", + Usage: "The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.\n", BodyPath: "previous_response_id", }, &requestflag.Flag[map[string]any]{ Name: "prompt", - Usage: "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).\n", + Usage: "Reference to a prompt template and its variables.\n[Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).\n", BodyPath: "prompt", }, &requestflag.Flag[*string]{ Name: "prompt-cache-key", - Usage: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n", + Usage: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).\n", BodyPath: "prompt_cache_key", }, &requestflag.Flag[map[string]any]{ Name: "prompt-cache-options", - Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details.", + Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.", BodyPath: "prompt_cache_options", }, &requestflag.Flag[*string]{ Name: "prompt-cache-retention", - Usage: "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n", + Usage: "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n", BodyPath: "prompt_cache_retention", }, &requestflag.Flag[map[string]any]{ Name: "reasoning", - Usage: "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + Usage: "Configuration options for\n[reasoning models](https://developers.openai.com/api/docs/guides/reasoning).\n", BodyPath: "reasoning", }, &requestflag.Flag[*string]{ Name: "safety-identifier", - Usage: "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).\n", + Usage: "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "safety_identifier", }, &requestflag.Flag[*string]{ Name: "service-tier", - Usage: "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.\n - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.\n - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n", + Usage: "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.\n - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.\n - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n", Default: requestflag.Ptr[string]("auto"), BodyPath: "service_tier", }, &requestflag.Flag[*bool]{ Name: "store", - Usage: "Whether to store the generated model response for later retrieval via\nAPI.\nDefaults to true when omitted.\nIf set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](/api/docs/guides/your-data#v1responses).\n", + Usage: "Whether to store the generated model response for later retrieval via\nAPI.\nDefaults to true when omitted.\nIf set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).\n", Default: requestflag.Ptr[bool](true), BodyPath: "store", }, &requestflag.Flag[*bool]{ Name: "stream", - Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)\nfor more information.\n", + Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)\nfor more information.\n", Default: requestflag.Ptr[bool](false), BodyPath: "stream", }, @@ -152,7 +152,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[map[string]any]{ Name: "text", - Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://platform.openai.com/docs/guides/text)\n- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)\n", + Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)\n", BodyPath: "text", }, &requestflag.Flag[any]{ @@ -162,7 +162,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[[]map[string]any]{ Name: "tool", - Usage: "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nWe support the following categories of tools:\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search)\n or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about\n [built-in tools](https://platform.openai.com/docs/guides/tools).\n- **MCP Tools**: Integrations with third-party systems via custom MCP servers\n or predefined connectors such as Google Drive and SharePoint. Learn more about\n [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code with strongly typed arguments\n and outputs. Learn more about\n [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use\n custom tools to call your own code.\n", + Usage: "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nWe support the following categories of tools:\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](https://developers.openai.com/api/docs/guides/tools-web-search)\n or [file search](https://developers.openai.com/api/docs/guides/tools-file-search). Learn more about\n [built-in tools](https://developers.openai.com/api/docs/guides/tools).\n- **MCP Tools**: Integrations with third-party systems via custom MCP servers\n or predefined connectors such as Google Drive and SharePoint. Learn more about\n [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code with strongly typed arguments\n and outputs. Learn more about\n [function calling](https://developers.openai.com/api/docs/guides/function-calling). You can also use\n custom tools to call your own code.\n", BodyPath: "tools", }, &requestflag.Flag[*int64]{ @@ -184,7 +184,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "user", - Usage: "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).\n", + Usage: "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, &requestflag.Flag[[]string]{ @@ -279,7 +279,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.InnerFlag[*string]{ Name: "reasoning.effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", InnerField: "effort", }, &requestflag.InnerFlag[*string]{ @@ -308,7 +308,7 @@ var betaResponsesCreate = requestflag.WithInnerFlags(cli.Command{ "text": { &requestflag.InnerFlag[map[string]any]{ Name: "text.format", - Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", + Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", InnerField: "format", }, &requestflag.InnerFlag[*string]{ @@ -346,7 +346,7 @@ var betaResponsesRetrieve = cli.Command{ }, &requestflag.Flag[bool]{ Name: "stream", - Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)\nfor more information.\n", + Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)\nfor more information.\n", QueryPath: "stream", }, &requestflag.Flag[[]string]{ @@ -383,7 +383,7 @@ var betaResponsesDelete = cli.Command{ var betaResponsesCancel = cli.Command{ Name: "cancel", - Usage: "Cancels a model response with the given ID. Only responses created with the\n`background` parameter set to `true` can be cancelled.\n[Learn more](https://platform.openai.com/docs/guides/background).", + Usage: "Cancels a model response with the given ID. Only responses created with the\n`background` parameter set to `true` can be cancelled.\n[Learn more](https://developers.openai.com/api/docs/guides/background).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ @@ -407,7 +407,7 @@ var betaResponsesCompact = requestflag.WithInnerFlags(cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[*string]{ Name: "model", - Usage: "Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models.", + Usage: "Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.", Required: true, BodyPath: "model", }, @@ -423,7 +423,7 @@ var betaResponsesCompact = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "previous-response-id", - Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", + Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", BodyPath: "previous_response_id", }, &requestflag.Flag[*string]{ @@ -433,7 +433,7 @@ var betaResponsesCompact = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[map[string]any]{ Name: "prompt-cache-options", - Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details.", + Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.", BodyPath: "prompt_cache_options", }, &requestflag.Flag[*string]{ @@ -443,7 +443,7 @@ var betaResponsesCompact = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "service-tier", - Usage: "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'.\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", + Usage: "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'.\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", BodyPath: "service_tier", }, &requestflag.Flag[[]string]{ diff --git a/pkg/cmd/betaresponseinputtoken.go b/pkg/cmd/betaresponseinputtoken.go index f2199e87..505fdac8 100644 --- a/pkg/cmd/betaresponseinputtoken.go +++ b/pkg/cmd/betaresponseinputtoken.go @@ -36,7 +36,7 @@ var betaResponsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "model", - Usage: "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models.", + Usage: "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.", BodyPath: "model", }, &requestflag.Flag[*bool]{ @@ -51,17 +51,17 @@ var betaResponsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "previous-response-id", - Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", + Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", BodyPath: "previous_response_id", }, &requestflag.Flag[map[string]any]{ Name: "reasoning", - Usage: "**gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).", + Usage: "**gpt-5 and o-series models only** Configuration options for [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).", BodyPath: "reasoning", }, &requestflag.Flag[map[string]any]{ Name: "text", - Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://platform.openai.com/docs/guides/text)\n- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)\n", + Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)\n", BodyPath: "text", }, &requestflag.Flag[any]{ @@ -95,7 +95,7 @@ var betaResponsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.InnerFlag[*string]{ Name: "reasoning.effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", InnerField: "effort", }, &requestflag.InnerFlag[*string]{ @@ -117,7 +117,7 @@ var betaResponsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ "text": { &requestflag.InnerFlag[map[string]any]{ Name: "text.format", - Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", + Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", InnerField: "format", }, &requestflag.InnerFlag[*string]{ diff --git a/pkg/cmd/betathread.go b/pkg/cmd/betathread.go index ed61f6b4..15fb9283 100644 --- a/pkg/cmd/betathread.go +++ b/pkg/cmd/betathread.go @@ -21,7 +21,7 @@ var betaThreadsCreate = requestflag.WithInnerFlags(cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[[]map[string]any]{ Name: "message", - Usage: "A list of [messages](https://platform.openai.com/docs/api-reference/messages) to start the thread with.", + Usage: "A list of [messages](https://developers.openai.com/api/docs/assistants/migration) to start the thread with.", BodyPath: "messages", }, &requestflag.Flag[map[string]any]{ @@ -145,7 +145,7 @@ var betaThreadsCreateAndRun = requestflag.WithInnerFlags(cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[string]{ Name: "assistant-id", - Usage: "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run.", + Usage: "The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run.", Required: true, BodyPath: "assistant_id", }, @@ -171,18 +171,18 @@ var betaThreadsCreateAndRun = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "model", - Usage: "The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + Usage: "The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", BodyPath: "model", }, &requestflag.Flag[bool]{ Name: "parallel-tool-calls", - Usage: "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + Usage: "Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.", Default: true, BodyPath: "parallel_tool_calls", }, &requestflag.Flag[any]{ Name: "response-format", - Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o), [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", BodyPath: "response_format", }, &requestflag.Flag[*bool]{ @@ -238,7 +238,7 @@ var betaThreadsCreateAndRun = requestflag.WithInnerFlags(cli.Command{ "thread": { &requestflag.InnerFlag[[]map[string]any]{ Name: "thread.messages", - Usage: "A list of [messages](https://platform.openai.com/docs/api-reference/messages) to start the thread with.", + Usage: "A list of [messages](https://developers.openai.com/api/docs/assistants/migration) to start the thread with.", InnerField: "messages", }, &requestflag.InnerFlag[map[string]any]{ diff --git a/pkg/cmd/betathreadrun.go b/pkg/cmd/betathreadrun.go index bc45ed77..38155a95 100644 --- a/pkg/cmd/betathreadrun.go +++ b/pkg/cmd/betathreadrun.go @@ -26,13 +26,13 @@ var betaThreadsRunsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "assistant-id", - Usage: "The ID of the [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to execute this run.", + Usage: "The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run.", Required: true, BodyPath: "assistant_id", }, &requestflag.Flag[[]string]{ Name: "include", - Usage: "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + Usage: "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information.\n", QueryPath: "include", }, &requestflag.Flag[*string]{ @@ -47,7 +47,7 @@ var betaThreadsRunsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "instructions", - Usage: "Overrides the [instructions](https://platform.openai.com/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.", + Usage: "Overrides the [instructions](https://developers.openai.com/api/docs/assistants/migration) of the assistant. This is useful for modifying the behavior on a per-run basis.", BodyPath: "instructions", }, &requestflag.Flag[*int64]{ @@ -67,24 +67,24 @@ var betaThreadsRunsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "model", - Usage: "The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + Usage: "The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", BodyPath: "model", }, &requestflag.Flag[bool]{ Name: "parallel-tool-calls", - Usage: "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + Usage: "Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.", Default: true, BodyPath: "parallel_tool_calls", }, &requestflag.Flag[*string]{ Name: "reasoning-effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", Default: requestflag.Ptr[string]("medium"), BodyPath: "reasoning_effort", }, &requestflag.Flag[any]{ Name: "response-format", - Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + Usage: "Specifies the format that the model must output. Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o), [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", BodyPath: "response_format", }, &requestflag.Flag[*bool]{ diff --git a/pkg/cmd/betathreadrunstep.go b/pkg/cmd/betathreadrunstep.go index 2786237d..929b6681 100644 --- a/pkg/cmd/betathreadrunstep.go +++ b/pkg/cmd/betathreadrunstep.go @@ -36,7 +36,7 @@ var betaThreadsRunsStepsRetrieve = cli.Command{ }, &requestflag.Flag[[]string]{ Name: "include", - Usage: "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + Usage: "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information.\n", QueryPath: "include", }, }, @@ -71,7 +71,7 @@ var betaThreadsRunsStepsList = cli.Command{ }, &requestflag.Flag[[]string]{ Name: "include", - Usage: "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n", + Usage: "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information.\n", QueryPath: "include", }, &requestflag.Flag[int64]{ diff --git a/pkg/cmd/call.go b/pkg/cmd/call.go index b1548cb8..10d3823b 100644 --- a/pkg/cmd/call.go +++ b/pkg/cmd/call.go @@ -68,7 +68,7 @@ var realtimeCallsAccept = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[map[string]any]{ Name: "prompt", - Usage: "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).\n", + Usage: "Reference to a prompt template and its variables.\n[Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).\n", BodyPath: "prompt", }, &requestflag.Flag[map[string]any]{ diff --git a/pkg/cmd/chatcompletion.go b/pkg/cmd/chatcompletion.go index cda214d3..761990df 100644 --- a/pkg/cmd/chatcompletion.go +++ b/pkg/cmd/chatcompletion.go @@ -16,24 +16,24 @@ import ( var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ Name: "create", - Usage: "**Starting a new project?** We recommend trying\n[Responses](https://platform.openai.com/docs/api-reference/responses) to take\nadvantage of the latest OpenAI platform features. Compare\n[Chat Completions with Responses](https://platform.openai.com/docs/guides/responses-vs-chat-completions?api-mode=responses).", + Usage: "**Starting a new project?** We recommend trying\n[Responses](https://developers.openai.com/api/reference/resources/responses) to\ntake advantage of the latest OpenAI platform features. Compare\n[Chat Completions with Responses](https://developers.openai.com/api/docs/guides/migrate-to-responses?api-mode=responses).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[[]map[string]any]{ Name: "message", - Usage: "A list of messages comprising the conversation so far. Depending on the\n[model](https://platform.openai.com/docs/models) you use, different message types (modalities) are\nsupported, like [text](https://platform.openai.com/docs/guides/text-generation),\n[images](https://platform.openai.com/docs/guides/vision), and [audio](https://platform.openai.com/docs/guides/audio).\n", + Usage: "A list of messages comprising the conversation so far. Depending on the\n[model](https://developers.openai.com/api/docs/models) you use, different message types (modalities) are\nsupported, like [text](https://developers.openai.com/api/docs/guides/text),\n[images](https://developers.openai.com/api/docs/guides/images-vision), and [audio](https://developers.openai.com/api/docs/guides/audio).\n", Required: true, BodyPath: "messages", }, &requestflag.Flag[string]{ Name: "model", - Usage: "Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models)\nto browse and compare available models.\n", + Usage: "Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models)\nto browse and compare available models.\n", Required: true, BodyPath: "model", }, &requestflag.Flag[map[string]any]{ Name: "audio", - Usage: "Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](https://platform.openai.com/docs/guides/audio).\n", + Usage: "Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](https://developers.openai.com/api/docs/guides/audio).\n", BodyPath: "audio", }, &requestflag.Flag[*float64]{ @@ -65,12 +65,12 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*int64]{ Name: "max-completion-tokens", - Usage: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).\n", + Usage: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).\n", BodyPath: "max_completion_tokens", }, &requestflag.Flag[*int64]{ Name: "max-tokens", - Usage: "The maximum number of [tokens](/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o-series models](https://platform.openai.com/docs/guides/reasoning).\n", + Usage: "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o-series models](https://developers.openai.com/api/docs/guides/reasoning).\n", BodyPath: "max_tokens", }, &requestflag.Flag[map[string]any]{ @@ -80,7 +80,7 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[any]{ Name: "modality", - Usage: "Output types that you would like the model to generate.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to\n[generate audio](https://platform.openai.com/docs/guides/audio). To request that this model generate\nboth text and audio responses, you can use:\n\n`[\"text\", \"audio\"]`\n", + Usage: "Output types that you would like the model to generate.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to\n[generate audio](https://developers.openai.com/api/docs/guides/audio). To request that this model generate\nboth text and audio responses, you can use:\n\n`[\"text\", \"audio\"]`\n", BodyPath: "modalities", }, &requestflag.Flag[map[string]any]{ @@ -96,7 +96,7 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[bool]{ Name: "parallel-tool-calls", - Usage: "Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", + Usage: "Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.", Default: true, BodyPath: "parallel_tool_calls", }, @@ -113,33 +113,33 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "prompt-cache-key", - Usage: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n", + Usage: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).\n", BodyPath: "prompt_cache_key", }, &requestflag.Flag[map[string]any]{ Name: "prompt-cache-options", - Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details.", + Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.", BodyPath: "prompt_cache_options", }, &requestflag.Flag[*string]{ Name: "prompt-cache-retention", - Usage: "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n", + Usage: "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n", BodyPath: "prompt_cache_retention", }, &requestflag.Flag[*string]{ Name: "reasoning-effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", Default: requestflag.Ptr[string]("medium"), BodyPath: "reasoning_effort", }, &requestflag.Flag[map[string]any]{ Name: "response-format", - Usage: "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](https://platform.openai.com/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", + Usage: "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", BodyPath: "response_format", }, &requestflag.Flag[*string]{ Name: "safety-identifier", - Usage: "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).\n", + Usage: "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "safety_identifier", }, &requestflag.Flag[*int64]{ @@ -149,7 +149,7 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "service-tier", - Usage: "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.\n - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n", + Usage: "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.\n - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n", Default: requestflag.Ptr[string]("auto"), BodyPath: "service_tier", }, @@ -160,13 +160,13 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*bool]{ Name: "store", - Usage: "Whether or not to store the output of this chat completion request for\nuse in our [model distillation](https://platform.openai.com/docs/guides/distillation) or\n[evals](https://platform.openai.com/docs/guides/evals) products.\n\nSupports text and image inputs. Note: image inputs over 8MB will be dropped.\n", + Usage: "Whether or not to store the output of this chat completion request for\nuse in our [model distillation](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#distilling-from-a-larger-model) or\n[evals](https://developers.openai.com/api/docs/guides/evals) products.\n\nSupports text and image inputs. Note: image inputs over 8MB will be dropped.\n", Default: requestflag.Ptr[bool](false), BodyPath: "store", }, &requestflag.Flag[*bool]{ Name: "stream", - Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)\nfor more information, along with the [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)\nguide for more information on how to handle the streaming events.\n", + Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events)\nfor more information, along with the [streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses)\nguide for more information on how to handle the streaming events.\n", Default: requestflag.Ptr[bool](false), BodyPath: "stream", }, @@ -188,7 +188,7 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[[]map[string]any]{ Name: "tool", - Usage: "A list of tools the model may call. You can provide either\n[custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools) or\n[function tools](https://platform.openai.com/docs/guides/function-calling).\n", + Usage: "A list of tools the model may call. You can provide either\n[custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools) or\n[function tools](https://developers.openai.com/api/docs/guides/function-calling).\n", BodyPath: "tools", }, &requestflag.Flag[*int64]{ @@ -204,7 +204,7 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "user", - Usage: "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).\n", + Usage: "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, &requestflag.Flag[*string]{ @@ -215,7 +215,7 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[map[string]any]{ Name: "web-search-options", - Usage: "This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).\n", + Usage: "This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).\n", BodyPath: "web_search_options", }, &requestflag.Flag[int64]{ @@ -251,7 +251,7 @@ var chatCompletionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.InnerFlag[map[string]any]{ Name: "function.parameters", - Usage: "The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", + Usage: "The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list.", InnerField: "parameters", }, }, diff --git a/pkg/cmd/completion.go b/pkg/cmd/completion.go index 30427ac5..2dae3e47 100644 --- a/pkg/cmd/completion.go +++ b/pkg/cmd/completion.go @@ -21,7 +21,7 @@ var completionsCreate = requestflag.WithInnerFlags(cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[string]{ Name: "model", - Usage: "ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them.\n", + Usage: "ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.\n", Required: true, BodyPath: "model", }, @@ -45,13 +45,13 @@ var completionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*float64]{ Name: "frequency-penalty", - Usage: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n\n[See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)\n", + Usage: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n\n[See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)\n", Default: requestflag.Ptr[float64](0), BodyPath: "frequency_penalty", }, &requestflag.Flag[map[string]any]{ Name: "logit-bias", - Usage: "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n", + Usage: "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n", BodyPath: "logit_bias", }, &requestflag.Flag[*int64]{ @@ -62,7 +62,7 @@ var completionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*int64]{ Name: "max-tokens", - Usage: "The maximum number of [tokens](/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n", + Usage: "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n", Default: requestflag.Ptr[int64](16), BodyPath: "max_tokens", }, @@ -74,7 +74,7 @@ var completionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*float64]{ Name: "presence-penalty", - Usage: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)\n", + Usage: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)\n", Default: requestflag.Ptr[float64](0), BodyPath: "presence_penalty", }, @@ -119,7 +119,7 @@ var completionsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "user", - Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).\n", + Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, &requestflag.Flag[int64]{ diff --git a/pkg/cmd/contentprovenancecheck.go b/pkg/cmd/contentprovenancecheck.go index 07de4fb4..2a9d68b1 100644 --- a/pkg/cmd/contentprovenancecheck.go +++ b/pkg/cmd/contentprovenancecheck.go @@ -16,7 +16,7 @@ import ( var contentProvenanceChecksCreate = cli.Command{ Name: "create", - Usage: "Check whether an image or audio file contains known OpenAI provenance signals.\n[Learn more about content provenance](/api/docs/guides/content-provenance).", + Usage: "Check whether an image or audio file contains known OpenAI provenance signals.\n[Learn more about content provenance](https://developers.openai.com/api/docs/guides/content-provenance).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ diff --git a/pkg/cmd/embedding.go b/pkg/cmd/embedding.go index 9a2b1b76..3e55e66c 100644 --- a/pkg/cmd/embedding.go +++ b/pkg/cmd/embedding.go @@ -21,13 +21,13 @@ var embeddingsCreate = cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[any]{ Name: "input", - Usage: "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.\n", + Usage: "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.\n", Required: true, BodyPath: "input", }, &requestflag.Flag[string]{ Name: "model", - Usage: "ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them.\n", + Usage: "ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.\n", Required: true, BodyPath: "model", }, @@ -44,7 +44,7 @@ var embeddingsCreate = cli.Command{ }, &requestflag.Flag[string]{ Name: "user", - Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).\n", + Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, }, diff --git a/pkg/cmd/finetuningalphagrader.go b/pkg/cmd/finetuningalphagrader.go index 41b59102..ecc34d4d 100644 --- a/pkg/cmd/finetuningalphagrader.go +++ b/pkg/cmd/finetuningalphagrader.go @@ -27,13 +27,13 @@ var fineTuningAlphaGradersRun = cli.Command{ }, &requestflag.Flag[string]{ Name: "model-sample", - Usage: "The model sample to be evaluated. This value will be used to populate \nthe `sample` namespace. See [the guide](https://platform.openai.com/docs/guides/graders) for more details.\nThe `output_json` variable will be populated if the model sample is a \nvalid JSON string.\n \n", + Usage: "The model sample to be evaluated. This value will be used to populate\nthe `sample` namespace. See [the guide](https://developers.openai.com/api/docs/guides/graders) for more details.\nThe `output_json` variable will be populated if the model sample is a\nvalid JSON string.\n", Required: true, BodyPath: "model_sample", }, &requestflag.Flag[any]{ Name: "item", - Usage: "The dataset item provided to the grader. This will be used to populate \nthe `item` namespace. See [the guide](https://platform.openai.com/docs/guides/graders) for more details. \n", + Usage: "The dataset item provided to the grader. This will be used to populate\nthe `item` namespace. See [the guide](https://developers.openai.com/api/docs/guides/graders) for more details.\n", BodyPath: "item", }, }, diff --git a/pkg/cmd/finetuningcheckpointpermission.go b/pkg/cmd/finetuningcheckpointpermission.go index 8b59a41e..9776ca45 100644 --- a/pkg/cmd/finetuningcheckpointpermission.go +++ b/pkg/cmd/finetuningcheckpointpermission.go @@ -16,7 +16,7 @@ import ( var fineTuningCheckpointsPermissionsCreate = cli.Command{ Name: "create", - Usage: "**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).", + Usage: "**NOTE:** Calling this endpoint requires an\n[admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ @@ -41,7 +41,7 @@ var fineTuningCheckpointsPermissionsCreate = cli.Command{ var fineTuningCheckpointsPermissionsRetrieve = cli.Command{ Name: "retrieve", - Usage: "**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).", + Usage: "**NOTE:** This endpoint requires an\n[admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ @@ -78,7 +78,7 @@ var fineTuningCheckpointsPermissionsRetrieve = cli.Command{ var fineTuningCheckpointsPermissionsList = cli.Command{ Name: "list", - Usage: "**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).", + Usage: "**NOTE:** This endpoint requires an\n[admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ @@ -119,7 +119,7 @@ var fineTuningCheckpointsPermissionsList = cli.Command{ var fineTuningCheckpointsPermissionsDelete = cli.Command{ Name: "delete", - Usage: "**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).", + Usage: "**NOTE:** This endpoint requires an\n[admin API key](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/admin_api_keys).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ diff --git a/pkg/cmd/finetuningjob.go b/pkg/cmd/finetuningjob.go index 5edb9233..a61f3cff 100644 --- a/pkg/cmd/finetuningjob.go +++ b/pkg/cmd/finetuningjob.go @@ -21,13 +21,13 @@ var fineTuningJobsCreate = requestflag.WithInnerFlags(cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[string]{ Name: "model", - Usage: "The name of the model to fine-tune. You can select one of the\n[supported models](https://platform.openai.com/docs/guides/fine-tuning#which-models-can-be-fine-tuned).\n", + Usage: "The name of the model to fine-tune. You can select one of the\n[supported models](https://developers.openai.com/api/docs/guides/model-optimization#fine-tuning-methods).\n", Required: true, BodyPath: "model", }, &requestflag.Flag[string]{ Name: "training-file", - Usage: "The ID of an uploaded file that contains training data.\n\nSee [upload file](https://platform.openai.com/docs/api-reference/files/create) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`.\n\nThe contents of the file should differ depending on if the model uses the [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input), [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input) format, or if the fine-tuning method uses the [preference](https://platform.openai.com/docs/api-reference/fine-tuning/preference-input) format.\n\nSee the [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization) for more details.\n", + Usage: "The ID of an uploaded file that contains training data.\n\nSee [upload file](https://developers.openai.com/api/reference/resources/files/methods/create) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`.\n\nThe contents of the file should differ depending on if the model uses the [chat](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data), [completions](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data) format, or if the fine-tuning method uses the [preference](https://developers.openai.com/api/docs/guides/direct-preference-optimization) format.\n\nSee the [fine-tuning guide](https://developers.openai.com/api/docs/guides/model-optimization) for more details.\n", Required: true, BodyPath: "training_file", }, @@ -64,7 +64,7 @@ var fineTuningJobsCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "validation-file", - Usage: "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation\nmetrics periodically during fine-tuning. These metrics can be viewed in\nthe fine-tuning results file.\nThe same data should not be present in both train and validation files.\n\nYour dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n\nSee the [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization) for more details.\n", + Usage: "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation\nmetrics periodically during fine-tuning. These metrics can be viewed in\nthe fine-tuning results file.\nThe same data should not be present in both train and validation files.\n\nYour dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n\nSee the [fine-tuning guide](https://developers.openai.com/api/docs/guides/model-optimization) for more details.\n", BodyPath: "validation_file", }, }, diff --git a/pkg/cmd/image.go b/pkg/cmd/image.go index 88954f1e..f228fc17 100644 --- a/pkg/cmd/image.go +++ b/pkg/cmd/image.go @@ -51,7 +51,7 @@ var imagesCreateVariation = cli.Command{ }, &requestflag.Flag[string]{ Name: "user", - Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).\n", + Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, }, @@ -141,13 +141,13 @@ var imagesEdit = cli.Command{ }, &requestflag.Flag[*bool]{ Name: "stream", - Usage: "Edit the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](https://platform.openai.com/docs/guides/image-generation) for more information.\n", + Usage: "Edit the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](https://developers.openai.com/api/docs/guides/image-generation) for more information.\n", Default: requestflag.Ptr[bool](false), BodyPath: "stream", }, &requestflag.Flag[string]{ Name: "user", - Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).\n", + Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, &requestflag.Flag[int64]{ @@ -161,7 +161,7 @@ var imagesEdit = cli.Command{ var imagesGenerate = cli.Command{ Name: "generate", - Usage: "Creates an image given a prompt.\n[Learn more](https://platform.openai.com/docs/guides/images).", + Usage: "Creates an image given a prompt.\n[Learn more](https://developers.openai.com/api/docs/guides/images-vision).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ @@ -230,7 +230,7 @@ var imagesGenerate = cli.Command{ }, &requestflag.Flag[*bool]{ Name: "stream", - Usage: "Generate the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](https://platform.openai.com/docs/guides/image-generation) for more information.\nThis parameter is only supported for the GPT image models.\n", + Usage: "Generate the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](https://developers.openai.com/api/docs/guides/image-generation) for more information.\nThis parameter is only supported for the GPT image models.\n", Default: requestflag.Ptr[bool](false), BodyPath: "stream", }, @@ -242,7 +242,7 @@ var imagesGenerate = cli.Command{ }, &requestflag.Flag[string]{ Name: "user", - Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).\n", + Usage: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, &requestflag.Flag[int64]{ diff --git a/pkg/cmd/inputtoken.go b/pkg/cmd/inputtoken.go index 47a375f9..8c0823f2 100644 --- a/pkg/cmd/inputtoken.go +++ b/pkg/cmd/inputtoken.go @@ -37,7 +37,7 @@ var responsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "model", - Usage: "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models.", + Usage: "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.", BodyPath: "model", }, &requestflag.Flag[*bool]{ @@ -52,17 +52,17 @@ var responsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "previous-response-id", - Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", + Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", BodyPath: "previous_response_id", }, &requestflag.Flag[map[string]any]{ Name: "reasoning", - Usage: "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + Usage: "Configuration options for\n[reasoning models](https://developers.openai.com/api/docs/guides/reasoning).\n", BodyPath: "reasoning", }, &requestflag.Flag[map[string]any]{ Name: "text", - Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://platform.openai.com/docs/guides/text)\n- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)\n", + Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)\n", BodyPath: "text", }, &requestflag.Flag[any]{ @@ -92,7 +92,7 @@ var responsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.InnerFlag[*string]{ Name: "reasoning.effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", InnerField: "effort", }, &requestflag.InnerFlag[*string]{ @@ -114,7 +114,7 @@ var responsesInputTokensCount = requestflag.WithInnerFlags(cli.Command{ "text": { &requestflag.InnerFlag[map[string]any]{ Name: "text.format", - Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", + Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", InnerField: "format", }, &requestflag.InnerFlag[*string]{ diff --git a/pkg/cmd/item.go b/pkg/cmd/item.go index 0db22f1e..7141afe4 100644 --- a/pkg/cmd/item.go +++ b/pkg/cmd/item.go @@ -33,7 +33,7 @@ var conversationsItemsCreate = cli.Command{ }, &requestflag.Flag[[]string]{ Name: "include", - Usage: "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.\n", + Usage: "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29) for more information.\n", QueryPath: "include", }, }, @@ -58,7 +58,7 @@ var conversationsItemsRetrieve = cli.Command{ }, &requestflag.Flag[[]string]{ Name: "include", - Usage: "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include) for more information.\n", + Usage: "Additional fields to include in the response. See the `include`\nparameter for [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29) for more information.\n", QueryPath: "include", }, }, diff --git a/pkg/cmd/moderation.go b/pkg/cmd/moderation.go index 6d433ea6..580a46a2 100644 --- a/pkg/cmd/moderation.go +++ b/pkg/cmd/moderation.go @@ -16,7 +16,7 @@ import ( var moderationsCreate = cli.Command{ Name: "create", - Usage: "Classifies if text and/or image inputs are potentially harmful. Learn more in\nthe [moderation guide](https://platform.openai.com/docs/guides/moderation).", + Usage: "Classifies if text and/or image inputs are potentially harmful. Learn more in\n[the moderation guide](https://developers.openai.com/api/docs/guides/moderation).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[any]{ @@ -27,7 +27,7 @@ var moderationsCreate = cli.Command{ }, &requestflag.Flag[string]{ Name: "model", - Usage: "The content moderation model you would like to use. Learn more in\n[the moderation guide](https://platform.openai.com/docs/guides/moderation), and learn about\navailable models [here](https://platform.openai.com/docs/models#moderation).\n", + Usage: "The content moderation model you would like to use. Learn more in\n[the moderation guide](https://developers.openai.com/api/docs/guides/moderation).\n", BodyPath: "model", }, }, diff --git a/pkg/cmd/response.go b/pkg/cmd/response.go index cd218869..60f6383a 100644 --- a/pkg/cmd/response.go +++ b/pkg/cmd/response.go @@ -17,12 +17,12 @@ import ( var responsesCreate = requestflag.WithInnerFlags(cli.Command{ Name: "create", - Usage: "Creates a model response. Provide\n[text](https://platform.openai.com/docs/guides/text) or\n[image](https://platform.openai.com/docs/guides/images) inputs to generate\n[text](https://platform.openai.com/docs/guides/text) or\n[JSON](https://platform.openai.com/docs/guides/structured-outputs) outputs. Have\nthe model call your own\n[custom code](https://platform.openai.com/docs/guides/function-calling) or use\nbuilt-in [tools](https://platform.openai.com/docs/guides/tools) like\n[web search](https://platform.openai.com/docs/guides/tools-web-search) or\n[file search](https://platform.openai.com/docs/guides/tools-file-search) to use\nyour own data as input for the model's response.", + Usage: "Creates a model response. Provide\n[text](https://developers.openai.com/api/docs/guides/text) or\n[image](https://developers.openai.com/api/docs/guides/images-vision) inputs to\ngenerate [text](https://developers.openai.com/api/docs/guides/text) or\n[JSON](https://developers.openai.com/api/docs/guides/structured-outputs)\noutputs. Have the model call your own\n[custom code](https://developers.openai.com/api/docs/guides/function-calling) or\nuse built-in [tools](https://developers.openai.com/api/docs/guides/tools) like\n[web search](https://developers.openai.com/api/docs/guides/tools-web-search) or\n[file search](https://developers.openai.com/api/docs/guides/tools-file-search)\nto use your own data as input for the model's response.", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[*bool]{ Name: "background", - Usage: "Whether to run the model response in the background.\n[Learn more](https://platform.openai.com/docs/guides/background).\n", + Usage: "Whether to run the model response in the background.\n[Learn more](https://developers.openai.com/api/docs/guides/background).\n", Default: requestflag.Ptr[bool](false), BodyPath: "background", }, @@ -43,7 +43,7 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[any]{ Name: "input", - Usage: "Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](https://platform.openai.com/docs/guides/text)\n- [Image inputs](https://platform.openai.com/docs/guides/images)\n- [File inputs](https://platform.openai.com/docs/guides/pdf-files)\n- [Conversation state](https://platform.openai.com/docs/guides/conversation-state)\n- [Function calling](https://platform.openai.com/docs/guides/function-calling)\n", + Usage: "Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Image inputs](https://developers.openai.com/api/docs/guides/images-vision)\n- [File inputs](https://developers.openai.com/api/docs/guides/file-inputs)\n- [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state)\n- [Function calling](https://developers.openai.com/api/docs/guides/function-calling)\n", BodyPath: "input", }, &requestflag.Flag[*string]{ @@ -53,7 +53,7 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*int64]{ Name: "max-output-tokens", - Usage: "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).\n", + Usage: "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).\n", BodyPath: "max_output_tokens", }, &requestflag.Flag[*int64]{ @@ -83,54 +83,54 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "previous-response-id", - Usage: "The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.\n", + Usage: "The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.\n", BodyPath: "previous_response_id", }, &requestflag.Flag[map[string]any]{ Name: "prompt", - Usage: "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).\n", + Usage: "Reference to a prompt template and its variables.\n[Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).\n", BodyPath: "prompt", }, &requestflag.Flag[*string]{ Name: "prompt-cache-key", - Usage: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://platform.openai.com/docs/guides/prompt-caching).\n", + Usage: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).\n", BodyPath: "prompt_cache_key", }, &requestflag.Flag[map[string]any]{ Name: "prompt-cache-options", - Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details.", + Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.", BodyPath: "prompt_cache_options", }, &requestflag.Flag[*string]{ Name: "prompt-cache-retention", - Usage: "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n", + Usage: "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n", BodyPath: "prompt_cache_retention", }, &requestflag.Flag[map[string]any]{ Name: "reasoning", - Usage: "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + Usage: "Configuration options for\n[reasoning models](https://developers.openai.com/api/docs/guides/reasoning).\n", BodyPath: "reasoning", }, &requestflag.Flag[*string]{ Name: "safety-identifier", - Usage: "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).\n", + Usage: "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "safety_identifier", }, &requestflag.Flag[*string]{ Name: "service-tier", - Usage: "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.\n - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.\n - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n", + Usage: "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.\n - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.\n - If set to 'ultrafast', then the request will be processed with the access-controlled Ultrafast Processing service tier. This tier is currently available for `gpt-5.6-sol`; a response served through it will show `service_tier=ultrafast`.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n", Default: requestflag.Ptr[string]("auto"), BodyPath: "service_tier", }, &requestflag.Flag[*bool]{ Name: "store", - Usage: "Whether to store the generated model response for later retrieval via\nAPI.\nDefaults to true when omitted.\nIf set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](/api/docs/guides/your-data#v1responses).\n", + Usage: "Whether to store the generated model response for later retrieval via\nAPI.\nDefaults to true when omitted.\nIf set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).\n", Default: requestflag.Ptr[bool](true), BodyPath: "store", }, &requestflag.Flag[*bool]{ Name: "stream", - Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)\nfor more information.\n", + Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)\nfor more information.\n", Default: requestflag.Ptr[bool](false), BodyPath: "stream", }, @@ -147,7 +147,7 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[map[string]any]{ Name: "text", - Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://platform.openai.com/docs/guides/text)\n- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)\n", + Usage: "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)\n", BodyPath: "text", }, &requestflag.Flag[any]{ @@ -157,7 +157,7 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[[]map[string]any]{ Name: "tool", - Usage: "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nWe support the following categories of tools:\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](https://platform.openai.com/docs/guides/tools-web-search)\n or [file search](https://platform.openai.com/docs/guides/tools-file-search). Learn more about\n [built-in tools](https://platform.openai.com/docs/guides/tools).\n- **MCP Tools**: Integrations with third-party systems via custom MCP servers\n or predefined connectors such as Google Drive and SharePoint. Learn more about\n [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code with strongly typed arguments\n and outputs. Learn more about\n [function calling](https://platform.openai.com/docs/guides/function-calling). You can also use\n custom tools to call your own code.\n", + Usage: "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nWe support the following categories of tools:\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](https://developers.openai.com/api/docs/guides/tools-web-search)\n or [file search](https://developers.openai.com/api/docs/guides/tools-file-search). Learn more about\n [built-in tools](https://developers.openai.com/api/docs/guides/tools).\n- **MCP Tools**: Integrations with third-party systems via custom MCP servers\n or predefined connectors such as Google Drive and SharePoint. Learn more about\n [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code with strongly typed arguments\n and outputs. Learn more about\n [function calling](https://developers.openai.com/api/docs/guides/function-calling). You can also use\n custom tools to call your own code.\n", BodyPath: "tools", }, &requestflag.Flag[*int64]{ @@ -179,7 +179,7 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[string]{ Name: "user", - Usage: "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).\n", + Usage: "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).\n", BodyPath: "user", }, &requestflag.Flag[int64]{ @@ -258,7 +258,7 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.InnerFlag[*string]{ Name: "reasoning.effort", - Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n", + Usage: "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning)\nfor model-specific support.\n", InnerField: "effort", }, &requestflag.InnerFlag[*string]{ @@ -287,7 +287,7 @@ var responsesCreate = requestflag.WithInnerFlags(cli.Command{ "text": { &requestflag.InnerFlag[map[string]any]{ Name: "text.format", - Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", + Usage: "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", InnerField: "format", }, &requestflag.InnerFlag[*string]{ @@ -325,7 +325,7 @@ var responsesRetrieve = cli.Command{ }, &requestflag.Flag[bool]{ Name: "stream", - Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://platform.openai.com/docs/api-reference/responses-streaming)\nfor more information.\n", + Usage: "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events)\nfor more information.\n", QueryPath: "stream", }, &requestflag.Flag[int64]{ @@ -354,7 +354,7 @@ var responsesDelete = cli.Command{ var responsesCancel = cli.Command{ Name: "cancel", - Usage: "Cancels a model response with the given ID. Only responses created with the\n`background` parameter set to `true` can be cancelled.\n[Learn more](https://platform.openai.com/docs/guides/background).", + Usage: "Cancels a model response with the given ID. Only responses created with the\n`background` parameter set to `true` can be cancelled.\n[Learn more](https://developers.openai.com/api/docs/guides/background).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ @@ -374,7 +374,7 @@ var responsesCompact = requestflag.WithInnerFlags(cli.Command{ Flags: []cli.Flag{ &requestflag.Flag[*string]{ Name: "model", - Usage: "Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://platform.openai.com/docs/models) to browse and compare available models.", + Usage: "Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.", Required: true, BodyPath: "model", }, @@ -390,7 +390,7 @@ var responsesCompact = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "previous-response-id", - Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://platform.openai.com/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", + Usage: "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.", BodyPath: "previous_response_id", }, &requestflag.Flag[*string]{ @@ -400,7 +400,7 @@ var responsesCompact = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[map[string]any]{ Name: "prompt-cache-options", - Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://platform.openai.com/docs/guides/prompt-caching) for current details.", + Usage: "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.", BodyPath: "prompt_cache_options", }, &requestflag.Flag[*string]{ @@ -410,7 +410,7 @@ var responsesCompact = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[*string]{ Name: "service-tier", - Usage: "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'.\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", + Usage: "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the default behavior is 'auto'.\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.", BodyPath: "service_tier", }, }, diff --git a/pkg/cmd/serviceaccountcreation_test.go b/pkg/cmd/serviceaccountcreation_test.go new file mode 100644 index 00000000..8b3a426f --- /dev/null +++ b/pkg/cmd/serviceaccountcreation_test.go @@ -0,0 +1,79 @@ +package cmd + +import ( + "io" + "net/http" + "net/http/httptest" + "testing" + + "github.com/stretchr/testify/require" + "github.com/urfave/cli/v3" +) + +func TestServiceAccountCreationRequestBody(t *testing.T) { + for _, test := range []struct { + name string + flags []string + wantBody string + }{ + { + name: "service account only omits expiry", + flags: []string{"--create-service-account-only=true"}, + wantBody: `{"name":"synthetic","create_service_account_only":true}`, + }, + { + name: "initial key with expiry", + flags: []string{"--create-service-account-only=false", "--expires-in-seconds", "86400"}, + wantBody: `{"name":"synthetic","create_service_account_only":false,"expires_in_seconds":86400}`, + }, + } { + t.Run(test.name, func(t *testing.T) { + received := make(chan []byte, 1) + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + body, err := io.ReadAll(r.Body) + if err != nil { + http.Error(w, err.Error(), http.StatusBadRequest) + return + } + received <- body + w.Header().Set("Content-Type", "application/json") + _, _ = io.WriteString(w, `{"id":"svc_synthetic","object":"organization.project.service_account","name":"synthetic"}`) + })) + t.Cleanup(server.Close) + + create := adminOrganizationProjectsServiceAccountsCreate + command := &cli.Command{ + Name: "openai", + Flags: []cli.Flag{ + &cli.StringFlag{Name: "base-url"}, + &cli.StringFlag{Name: "api-key"}, + &cli.StringFlag{Name: "admin-api-key"}, + &cli.StringFlag{Name: "format", Value: "json"}, + &cli.StringFlag{Name: "transform"}, + &cli.BoolFlag{Name: "raw-output"}, + }, + Commands: []*cli.Command{{ + Name: "admin:organization:projects:service-accounts", + Commands: []*cli.Command{&create}, + }}, + } + args := []string{ + "openai", + "--base-url", server.URL + "/", + "--api-key", "synthetic-key", + "--admin-api-key", "synthetic-admin-key", + "admin:organization:projects:service-accounts", "create", + "--project-id", "proj_synthetic", + "--name", "synthetic", + } + require.NoError(t, command.Run(t.Context(), append(args, test.flags...))) + + select { + case body := <-received: + require.JSONEq(t, test.wantBody, string(body)) + default: + t.Fatal("CLI did not send a request") + } + }) + } +} diff --git a/pkg/cmd/upload.go b/pkg/cmd/upload.go index dd731d1b..a9ccd037 100644 --- a/pkg/cmd/upload.go +++ b/pkg/cmd/upload.go @@ -16,7 +16,7 @@ import ( var uploadsCreate = requestflag.WithInnerFlags(cli.Command{ Name: "create", - Usage: "Creates an intermediate\n[Upload](https://platform.openai.com/docs/api-reference/uploads/object) object\nthat you can add\n[Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.\nCurrently, an Upload can accept at most 8 GB in total and expires after an hour\nafter you create it.", + Usage: "Creates an intermediate\n[Upload](https://developers.openai.com/api/reference/resources/uploads) object\nthat you can add\n[Parts](https://developers.openai.com/api/reference/resources/uploads/subresources/parts)\nto. Currently, an Upload can accept at most 8 GB in total and expires after an\nhour after you create it.", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[int64]{ @@ -83,7 +83,7 @@ var uploadsCancel = cli.Command{ var uploadsComplete = cli.Command{ Name: "complete", - Usage: "Completes the\n[Upload](https://platform.openai.com/docs/api-reference/uploads/object).", + Usage: "Completes the\n[Upload](https://developers.openai.com/api/reference/resources/uploads).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ diff --git a/pkg/cmd/uploadpart.go b/pkg/cmd/uploadpart.go index 978b525d..b7deb8b8 100644 --- a/pkg/cmd/uploadpart.go +++ b/pkg/cmd/uploadpart.go @@ -16,7 +16,7 @@ import ( var uploadsPartsCreate = cli.Command{ Name: "create", - Usage: "Adds a\n[Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an\n[Upload](https://platform.openai.com/docs/api-reference/uploads/object) object.\nA Part represents a chunk of bytes from the file you are trying to upload.", + Usage: "Adds a\n[Part](https://developers.openai.com/api/reference/resources/uploads/subresources/parts)\nto an [Upload](https://developers.openai.com/api/reference/resources/uploads)\nobject. A Part represents a chunk of bytes from the file you are trying to\nupload.", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ diff --git a/pkg/cmd/vectorstore.go b/pkg/cmd/vectorstore.go index a6195f01..a37cab64 100644 --- a/pkg/cmd/vectorstore.go +++ b/pkg/cmd/vectorstore.go @@ -36,7 +36,7 @@ var vectorStoresCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[[]string]{ Name: "file-id", - Usage: "A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + Usage: "A list of [File](https://developers.openai.com/api/reference/resources/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files.", BodyPath: "file_ids", }, &requestflag.Flag[map[string]any]{ diff --git a/pkg/cmd/vectorstorefile.go b/pkg/cmd/vectorstorefile.go index aaabb7dc..e09c4dfb 100644 --- a/pkg/cmd/vectorstorefile.go +++ b/pkg/cmd/vectorstorefile.go @@ -16,7 +16,7 @@ import ( var vectorStoresFilesCreate = cli.Command{ Name: "create", - Usage: "Create a vector store file by attaching a\n[File](https://platform.openai.com/docs/api-reference/files) to a\n[vector store](https://platform.openai.com/docs/api-reference/vector-stores/object).", + Usage: "Create a vector store file by attaching a\n[File](https://developers.openai.com/api/reference/resources/files) to a\n[vector store](https://developers.openai.com/api/reference/resources/vector_stores).", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ @@ -26,7 +26,7 @@ var vectorStoresFilesCreate = cli.Command{ }, &requestflag.Flag[string]{ Name: "file-id", - Usage: "A [File](https://platform.openai.com/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests.", + Usage: "A [File](https://developers.openai.com/api/reference/resources/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create) to minimize per-vector-store write requests.", Required: true, BodyPath: "file_id", }, @@ -139,7 +139,7 @@ var vectorStoresFilesList = cli.Command{ var vectorStoresFilesDelete = cli.Command{ Name: "delete", - Usage: "Delete a vector store file. This will remove the file from the vector store but\nthe file itself will not be deleted. To delete the file, use the\n[delete file](https://platform.openai.com/docs/api-reference/files/delete)\nendpoint.", + Usage: "Delete a vector store file. This will remove the file from the vector store but\nthe file itself will not be deleted. To delete the file, use the\n[delete file](https://developers.openai.com/api/reference/resources/files/methods/delete)\nendpoint.", Suggest: true, Flags: []cli.Flag{ &requestflag.Flag[string]{ diff --git a/pkg/cmd/vectorstorefilebatch.go b/pkg/cmd/vectorstorefilebatch.go index 84357fc1..a140f2f8 100644 --- a/pkg/cmd/vectorstorefilebatch.go +++ b/pkg/cmd/vectorstorefilebatch.go @@ -36,7 +36,7 @@ var vectorStoresFileBatchesCreate = requestflag.WithInnerFlags(cli.Command{ }, &requestflag.Flag[[]string]{ Name: "file-id", - Usage: "A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.", + Usage: "A list of [File](https://developers.openai.com/api/reference/resources/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.", BodyPath: "file_ids", }, &requestflag.Flag[[]map[string]any]{ @@ -51,7 +51,7 @@ var vectorStoresFileBatchesCreate = requestflag.WithInnerFlags(cli.Command{ "file": { &requestflag.InnerFlag[string]{ Name: "file.file-id", - Usage: "A [File](https://platform.openai.com/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch) to minimize per-vector-store write requests.", + Usage: "A [File](https://developers.openai.com/api/reference/resources/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create) to minimize per-vector-store write requests.", InnerField: "file_id", }, &requestflag.InnerFlag[map[string]any]{