diff --git a/en/resources/responses/index.md b/en/resources/responses/index.md index 05025fa3..f45b1ba9 100644 --- a/en/resources/responses/index.md +++ b/en/resources/responses/index.md @@ -1500,7 +1500,7 @@ the `background` parameter set to `true` can be cancelled. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -1513,6 +1513,10 @@ the `background` parameter set to `true` can be cancelled. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -2535,7 +2539,7 @@ the `background` parameter set to `true` can be cancelled. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -2548,6 +2552,10 @@ the `background` parameter set to `true` can be cancelled. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -4165,7 +4173,7 @@ the `background` parameter set to `true` can be cancelled. - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -4175,6 +4183,8 @@ the `background` parameter set to `true` can be cancelled. - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -4331,7 +4341,7 @@ the `background` parameter set to `true` can be cancelled. - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -4353,6 +4363,10 @@ the `background` parameter set to `true` can be cancelled. - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -5139,7 +5153,7 @@ the `background` parameter set to `true` can be cancelled. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -5152,6 +5166,10 @@ the `background` parameter set to `true` can be cancelled. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -5988,7 +6006,7 @@ the `background` parameter set to `true` can be cancelled. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -6001,6 +6019,10 @@ the `background` parameter set to `true` can be cancelled. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -7836,7 +7858,7 @@ the `background` parameter set to `true` can be cancelled. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -7849,6 +7871,10 @@ the `background` parameter set to `true` can be cancelled. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -8838,7 +8864,7 @@ the `background` parameter set to `true` can be cancelled. 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -8846,6 +8872,7 @@ the `background` parameter set to `true` can be cancelled. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -8862,6 +8889,8 @@ the `background` parameter set to `true` can be cancelled. - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -9289,11 +9318,11 @@ Learn when and how to compact long-running conversations in the [conversation st ### Body Parameters -- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more or string or null` +- `model: "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more or string or null` Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 96 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 99 more` Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models. @@ -9305,6 +9334,8 @@ Learn when and how to compact long-running conversations in the [conversation st - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -9481,6 +9512,10 @@ Learn when and how to compact long-running conversations in the [conversation st - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -10903,7 +10938,7 @@ Learn when and how to compact long-running conversations in the [conversation st - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -10916,6 +10951,10 @@ Learn when and how to compact long-running conversations in the [conversation st - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -11938,7 +11977,7 @@ Learn when and how to compact long-running conversations in the [conversation st - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -11951,6 +11990,10 @@ Learn when and how to compact long-running conversations in the [conversation st - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -14411,7 +14454,7 @@ Learn when and how to compact long-running conversations in the [conversation st - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -14424,6 +14467,10 @@ Learn when and how to compact long-running conversations in the [conversation st - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -15442,7 +15489,7 @@ Learn when and how to compact long-running conversations in the [conversation st - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -15455,6 +15502,10 @@ Learn when and how to compact long-running conversations in the [conversation st - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -19251,7 +19302,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -19264,6 +19315,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -20286,7 +20341,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -20299,6 +20354,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -21932,7 +21991,7 @@ as input for the model's response. - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -21942,6 +22001,8 @@ as input for the model's response. - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -22098,7 +22159,7 @@ as input for the model's response. - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -22120,6 +22181,10 @@ as input for the model's response. - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -22348,7 +22413,7 @@ as input for the model's response. 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](/docs/guides/safety-best-practices#safety-identifiers). -- `service_tier: optional "auto" or "default" or "flex" or 3 more or null` +- `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -22356,6 +22421,7 @@ as input for the model's response. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -22372,6 +22438,8 @@ as input for the model's response. - `"fast"` + - `"ultrafast"` + - `store: optional boolean or null` Whether to store the generated model response for later retrieval via @@ -22829,7 +22897,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -22842,6 +22910,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -25020,7 +25092,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -25033,6 +25105,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -26055,7 +26131,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -26068,6 +26144,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -27685,7 +27765,7 @@ as input for the model's response. - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -27695,6 +27775,8 @@ as input for the model's response. - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -27851,7 +27933,7 @@ as input for the model's response. - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -27873,6 +27955,10 @@ as input for the model's response. - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -28659,7 +28745,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -28672,6 +28758,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -29508,7 +29598,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -29521,6 +29611,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -31356,7 +31450,7 @@ as input for the model's response. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -31369,6 +31463,10 @@ as input for the model's response. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -32358,7 +32456,7 @@ as input for the model's response. 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -32366,6 +32464,7 @@ as input for the model's response. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -32382,6 +32481,8 @@ as input for the model's response. - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -35086,7 +35187,7 @@ Retrieves a model response with the given ID. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -35099,6 +35200,10 @@ Retrieves a model response with the given ID. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -36121,7 +36226,7 @@ Retrieves a model response with the given ID. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -36134,6 +36239,10 @@ Retrieves a model response with the given ID. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -37751,7 +37860,7 @@ Retrieves a model response with the given ID. - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -37761,6 +37870,8 @@ Retrieves a model response with the given ID. - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -37917,7 +38028,7 @@ Retrieves a model response with the given ID. - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -37939,6 +38050,10 @@ Retrieves a model response with the given ID. - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -38725,7 +38840,7 @@ Retrieves a model response with the given ID. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -38738,6 +38853,10 @@ Retrieves a model response with the given ID. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -39574,7 +39693,7 @@ Retrieves a model response with the given ID. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -39587,6 +39706,10 @@ Retrieves a model response with the given ID. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -41422,7 +41545,7 @@ Retrieves a model response with the given ID. - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -41435,6 +41558,10 @@ Retrieves a model response with the given ID. - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -42424,7 +42551,7 @@ Retrieves a model response with the given ID. 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -42432,6 +42559,7 @@ Retrieves a model response with the given ID. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -42448,6 +42576,8 @@ Retrieves a model response with the given ID. - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -43683,7 +43813,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -43696,6 +43826,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -44714,7 +44848,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -44727,6 +44861,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -49247,7 +49385,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -49260,6 +49398,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -50282,7 +50424,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -50295,6 +50437,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -51912,7 +52058,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -51922,6 +52068,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -52078,7 +52226,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -52100,6 +52248,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -52886,7 +53038,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -52899,6 +53051,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -53735,7 +53891,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -53748,6 +53904,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -55583,7 +55743,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -55596,6 +55756,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -56585,7 +56749,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -56593,6 +56757,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -56609,6 +56774,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -58479,7 +58646,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -58492,6 +58659,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -59514,7 +59685,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -59527,6 +59698,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -61144,7 +61319,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -61154,6 +61329,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -61310,7 +61487,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -61332,6 +61509,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -62118,7 +62299,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -62131,6 +62312,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -62967,7 +63152,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -62980,6 +63165,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -64815,7 +65004,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -64828,6 +65017,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -65817,7 +66010,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -65825,6 +66018,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -65841,6 +66035,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -68220,7 +68416,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -68233,6 +68429,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -69255,7 +69455,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -69268,6 +69468,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -70885,7 +71089,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -70895,6 +71099,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -71051,7 +71257,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -71073,6 +71279,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -71859,7 +72069,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -71872,6 +72082,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -72708,7 +72922,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -72721,6 +72935,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -74556,7 +74774,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -74569,6 +74787,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -75558,7 +75780,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -75566,6 +75788,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -75582,6 +75805,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -77400,7 +77625,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -77413,6 +77638,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -78435,7 +78664,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -78448,6 +78677,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -80065,7 +80298,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -80075,6 +80308,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -80231,7 +80466,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -80253,6 +80488,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -81039,7 +81278,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -81052,6 +81291,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -81888,7 +82131,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -81901,6 +82144,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -83736,7 +83983,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -83749,6 +83996,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -84738,7 +84989,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -84746,6 +84997,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -84762,6 +85014,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -86829,7 +87083,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -86842,6 +87096,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -87864,7 +88122,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -87877,6 +88135,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -89494,7 +89756,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -89504,6 +89766,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -89660,7 +89924,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -89682,6 +89946,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -90468,7 +90736,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -90481,6 +90749,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -91317,7 +91589,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -91330,6 +91602,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -93165,7 +93441,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -93178,6 +93454,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -94167,7 +94447,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -94175,6 +94455,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -94191,6 +94472,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -95902,7 +96185,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -95915,6 +96198,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -96937,7 +97224,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -96950,6 +97237,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -98567,7 +98858,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -98577,6 +98868,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -98733,7 +99026,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -98755,6 +99048,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -99541,7 +99838,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -99554,6 +99851,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -100390,7 +100691,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -100403,6 +100704,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -102238,7 +102543,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -102251,6 +102556,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -103240,7 +103549,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -103248,6 +103557,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -103264,6 +103574,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -105679,7 +105991,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -105692,6 +106004,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -106710,7 +107026,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -106723,6 +107039,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -109576,7 +109896,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -109589,6 +109909,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -110607,7 +110931,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -110620,6 +110944,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -113487,7 +113815,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -113500,6 +113828,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -114518,7 +114850,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -114531,6 +114863,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -118041,7 +118377,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -118054,6 +118390,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -119076,7 +119416,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -119089,6 +119429,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -120706,7 +121050,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -120716,6 +121060,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -120872,7 +121218,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -120894,6 +121240,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -121680,7 +122030,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -121693,6 +122043,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -122529,7 +122883,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -122542,6 +122896,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -124377,7 +124735,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -124390,6 +124748,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -125379,7 +125741,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -125387,6 +125749,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -125403,6 +125766,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -125895,7 +126260,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `ResponseStreamEvent = ResponseAudioDeltaEvent or ResponseAudioDoneEvent or ResponseAudioTranscriptDeltaEvent or 50 more` - Emitted when there is a partial audio response. + Event emitted while a response is streamed. - `ResponseAudioDeltaEvent object { delta, sequence_number, type }` @@ -127571,7 +127936,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -127584,6 +127949,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -128606,7 +128975,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -128619,6 +128988,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -130236,7 +130609,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -130246,6 +130619,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -130402,7 +130777,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -130424,6 +130799,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -131210,7 +131589,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -131223,6 +131602,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -132059,7 +132442,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -132072,6 +132455,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -133907,7 +134294,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -133920,6 +134307,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -134909,7 +135300,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -134917,6 +135308,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -134933,6 +135325,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `status: optional ResponseStatus` The status of the response generation. One of `completed`, `failed`, @@ -136735,7 +137129,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ ### Responses Client Event -- `ResponsesClientEvent object { type, background, context_management, 29 more }` +- `ResponsesClientEvent object { type, background, context_management, 30 more }` - `type: "response.create"` @@ -138221,7 +138615,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -138234,6 +138628,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -139256,7 +139654,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -139269,6 +139667,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -140902,7 +141304,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `string` - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` + - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - `"gpt-5.6-sol"` @@ -140912,6 +141314,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-5.5"` + - `"gpt-5.5-2026-04-23"` + - `"gpt-5.4"` - `"gpt-5.4-mini"` @@ -141068,7 +141472,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"gpt-3.5-turbo-16k-0613"` - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` + - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more` - `"o1-pro"` @@ -141090,6 +141494,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer-use-preview-2025-03-11"` + - `"gpt-5.5-pro"` + + - `"gpt-5.5-pro-2026-04-23"` + - `"gpt-5-codex"` - `"gpt-5-pro"` @@ -141318,7 +141726,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ 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](/docs/guides/safety-best-practices#safety-identifiers). - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` + - `service_tier: optional "auto" or "default" or "flex" or 4 more or null` Specifies the processing type used for serving the request. @@ -141326,6 +141734,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/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 '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'. 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. @@ -141342,6 +141751,8 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"fast"` + - `"ultrafast"` + - `store: optional boolean or null` Whether to store the generated model response for later retrieval via @@ -141354,6 +141765,16 @@ curl https://api.openai.com/v1/responses/resp_123 \ See the [Streaming section below](/docs/api-reference/responses-streaming) for more information. + - `stream_id: optional string` + + The WebSocket lane for this response. Requests with the same + `stream_id` are processed FIFO, and events for the response echo the + same `stream_id`. + + `stream_id` controls routing; `previous_response_id` controls + conversation lineage, so a new lane can fork from a response created + on another lane. + - `stream_options: optional object { include_obfuscation } or null` Options for streaming responses. Only set this when you set `stream: true`. @@ -141799,7 +142220,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -141812,6 +142233,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -142508,304 +142933,798 @@ curl https://api.openai.com/v1/responses/resp_123 \ Server events emitted by the Responses WebSocket server. - - `ResponseAudioDeltaEvent object { delta, sequence_number, type }` + - `ResponseAudioWsDelta = ResponseAudioDeltaEvent` Emitted when there is a partial audio response. - - `delta: string` + - `stream_id: optional string` - A chunk of Base64 encoded response audio bytes. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `sequence_number: number` + - `ResponseAudioWsDone = ResponseAudioDoneEvent` - A sequence number for this chunk of the stream response. + Emitted when the audio response is complete. - - `type: "response.audio.delta"` + - `stream_id: optional string` - The type of the event. Always `response.audio.delta`. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"response.audio.delta"` + - `ResponseAudioTranscriptWsDelta = ResponseAudioTranscriptDeltaEvent` - - `ResponseAudioDoneEvent object { sequence_number, type }` + Emitted when there is a partial transcript of audio. - Emitted when the audio response is complete. + - `stream_id: optional string` - - `sequence_number: number` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The sequence number of the delta. + - `ResponseAudioTranscriptWsDone = ResponseAudioTranscriptDoneEvent` - - `type: "response.audio.done"` + Emitted when the full audio transcript is completed. - The type of the event. Always `response.audio.done`. + - `stream_id: optional string` - - `"response.audio.done"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `ResponseAudioTranscriptDeltaEvent object { delta, sequence_number, type }` + - `ResponseCodeInterpreterCallCodeWsDelta = ResponseCodeInterpreterCallCodeDeltaEvent` - Emitted when there is a partial transcript of audio. + Emitted when a partial code snippet is streamed by the code interpreter. - - `delta: string` + - `stream_id: optional string` - The partial transcript of the audio response. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `sequence_number: number` + - `ResponseCodeInterpreterCallCodeWsDone = ResponseCodeInterpreterCallCodeDoneEvent` - The sequence number of this event. + Emitted when the code snippet is finalized by the code interpreter. - - `type: "response.audio.transcript.delta"` + - `stream_id: optional string` - The type of the event. Always `response.audio.transcript.delta`. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"response.audio.transcript.delta"` + - `ResponseCodeInterpreterCallWsCompleted = ResponseCodeInterpreterCallCompletedEvent` - - `ResponseAudioTranscriptDoneEvent object { sequence_number, type }` + Emitted when the code interpreter call is completed. - Emitted when the full audio transcript is completed. + - `stream_id: optional string` - - `sequence_number: number` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The sequence number of this event. + - `ResponseCodeInterpreterCallInWsProgress = ResponseCodeInterpreterCallInProgressEvent` - - `type: "response.audio.transcript.done"` + Emitted when a code interpreter call is in progress. - The type of the event. Always `response.audio.transcript.done`. + - `stream_id: optional string` - - `"response.audio.transcript.done"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `ResponseCodeInterpreterCallCodeDeltaEvent object { delta, item_id, output_index, 2 more }` + - `ResponseCodeInterpreterCallWsInterpreting = ResponseCodeInterpreterCallInterpretingEvent` - Emitted when a partial code snippet is streamed by the code interpreter. + Emitted when the code interpreter is actively interpreting the code snippet. - - `delta: string` + - `stream_id: optional string` - The partial code snippet being streamed by the code interpreter. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `item_id: string` + - `ResponseWsCompleted = ResponseCompletedEvent` - The unique identifier of the code interpreter tool call item. + Emitted when the model response is complete. - - `output_index: number` + - `stream_id: optional string` - The index of the output item in the response for which the code is being streamed. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `sequence_number: number` + - `ResponseContentPartWsAdded = ResponseContentPartAddedEvent` - The sequence number of this event, used to order streaming events. + Emitted when a new content part is added. - - `type: "response.code_interpreter_call_code.delta"` + - `stream_id: optional string` - The type of the event. Always `response.code_interpreter_call_code.delta`. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"response.code_interpreter_call_code.delta"` + - `ResponseContentPartWsDone = ResponseContentPartDoneEvent` - - `ResponseCodeInterpreterCallCodeDoneEvent object { code, item_id, output_index, 2 more }` + Emitted when a content part is done. - Emitted when the code snippet is finalized by the code interpreter. + - `stream_id: optional string` - - `code: string` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The final code snippet output by the code interpreter. + - `ResponseWsCreated = ResponseCreatedEvent` - - `item_id: string` + An event that is emitted when a response is created. - The unique identifier of the code interpreter tool call item. + - `stream_id: optional string` - - `output_index: number` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The index of the output item in the response for which the code is finalized. + - `ResponseWsError = ResponseErrorEvent` - - `sequence_number: number` + Emitted when an error occurs. - The sequence number of this event, used to order streaming events. + - `stream_id: optional string` - - `type: "response.code_interpreter_call_code.done"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The type of the event. Always `response.code_interpreter_call_code.done`. + - `ResponseFileSearchCallWsCompleted = ResponseFileSearchCallCompletedEvent` - - `"response.code_interpreter_call_code.done"` + Emitted when a file search call is completed (results found). - - `ResponseCodeInterpreterCallCompletedEvent object { item_id, output_index, sequence_number, type }` + - `stream_id: optional string` - Emitted when the code interpreter call is completed. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `item_id: string` + - `ResponseFileSearchCallInWsProgress = ResponseFileSearchCallInProgressEvent` - The unique identifier of the code interpreter tool call item. + Emitted when a file search call is initiated. - - `output_index: number` + - `stream_id: optional string` - The index of the output item in the response for which the code interpreter call is completed. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `sequence_number: number` + - `ResponseFileSearchCallWsSearching = ResponseFileSearchCallSearchingEvent` - The sequence number of this event, used to order streaming events. + Emitted when a file search is currently searching. - - `type: "response.code_interpreter_call.completed"` + - `stream_id: optional string` - The type of the event. Always `response.code_interpreter_call.completed`. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"response.code_interpreter_call.completed"` + - `ResponseFunctionCallArgumentsWsDelta = ResponseFunctionCallArgumentsDeltaEvent` - - `ResponseCodeInterpreterCallInProgressEvent object { item_id, output_index, sequence_number, type }` + Emitted when there is a partial function-call arguments delta. - Emitted when a code interpreter call is in progress. + - `stream_id: optional string` - - `item_id: string` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The unique identifier of the code interpreter tool call item. + - `ResponseFunctionCallArgumentsWsDone = ResponseFunctionCallArgumentsDoneEvent` - - `output_index: number` + Emitted when function-call arguments are finalized. - The index of the output item in the response for which the code interpreter call is in progress. + - `stream_id: optional string` - - `sequence_number: number` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The sequence number of this event, used to order streaming events. + - `ResponseInWsProgress = ResponseInProgressEvent` - - `type: "response.code_interpreter_call.in_progress"` + Emitted when the response is in progress. - The type of the event. Always `response.code_interpreter_call.in_progress`. + - `stream_id: optional string` - - `"response.code_interpreter_call.in_progress"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `ResponseCodeInterpreterCallInterpretingEvent object { item_id, output_index, sequence_number, type }` + - `ResponseWsFailed = ResponseFailedEvent` - Emitted when the code interpreter is actively interpreting the code snippet. + An event that is emitted when a response fails. - - `item_id: string` + - `stream_id: optional string` - The unique identifier of the code interpreter tool call item. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `output_index: number` + - `ResponseWsIncomplete = ResponseIncompleteEvent` - The index of the output item in the response for which the code interpreter is interpreting code. + An event that is emitted when a response finishes as incomplete. - - `sequence_number: number` + - `stream_id: optional string` - The sequence number of this event, used to order streaming events. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `type: "response.code_interpreter_call.interpreting"` + - `ResponseOutputItemWsAdded = ResponseOutputItemAddedEvent` - The type of the event. Always `response.code_interpreter_call.interpreting`. + Emitted when a new output item is added. - - `"response.code_interpreter_call.interpreting"` + - `stream_id: optional string` - - `ResponseCompletedEvent object { response, sequence_number, type }` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - Emitted when the model response is complete. + - `ResponseOutputItemWsDone = ResponseOutputItemDoneEvent` - - `response: Response` + Emitted when an output item is marked done. - Properties of the completed response. + - `stream_id: optional string` - - `id: string` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - Unique identifier for this Response. + - `ResponseReasoningSummaryPartWsAdded = ResponseReasoningSummaryPartAddedEvent` - - `created_at: number` + Emitted when a new reasoning summary part is added. - Unix timestamp (in seconds) of when this Response was created. + - `stream_id: optional string` - - `error: ResponseError or null` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - An error object returned when the model fails to generate a Response. + - `ResponseReasoningSummaryPartWsDone = ResponseReasoningSummaryPartDoneEvent` - - `code: "server_error" or "rate_limit_exceeded" or "invalid_prompt" or 17 more` + Emitted when a reasoning summary part is completed. - The error code for the response. + - `stream_id: optional string` - - `"server_error"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"rate_limit_exceeded"` + - `ResponseReasoningSummaryTextWsDelta = ResponseReasoningSummaryTextDeltaEvent` - - `"invalid_prompt"` + Emitted when a delta is added to a reasoning summary text. - - `"data_residency_mismatch"` + - `stream_id: optional string` - - `"bio_policy"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"vector_store_timeout"` + - `ResponseReasoningSummaryTextWsDone = ResponseReasoningSummaryTextDoneEvent` - - `"invalid_image"` + Emitted when a reasoning summary text is completed. - - `"invalid_image_format"` + - `stream_id: optional string` - - `"invalid_base64_image"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"invalid_image_url"` + - `ResponseReasoningTextWsDelta = ResponseReasoningTextDeltaEvent` - - `"image_too_large"` + Emitted when a delta is added to a reasoning text. - - `"image_too_small"` + - `stream_id: optional string` - - `"image_parse_error"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"image_content_policy_violation"` + - `ResponseReasoningTextWsDone = ResponseReasoningTextDoneEvent` - - `"invalid_image_mode"` + Emitted when a reasoning text is completed. - - `"image_file_too_large"` + - `stream_id: optional string` - - `"unsupported_image_media_type"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `"empty_image_file"` + - `ResponseRefusalWsDelta = ResponseRefusalDeltaEvent` - - `"failed_to_download_image"` + Emitted when there is a partial refusal text. - - `"image_file_not_found"` + - `stream_id: optional string` - - `message: string` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - A human-readable description of the error. + - `ResponseRefusalWsDone = ResponseRefusalDoneEvent` - - `incomplete_details: object { reason } or null` + Emitted when refusal text is finalized. - Details about why the response is incomplete. + - `stream_id: optional string` - - `reason: optional "max_output_tokens" or "content_filter"` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - The reason why the response is incomplete. + - `ResponseTextWsDelta = ResponseTextDeltaEvent` - - `"max_output_tokens"` + Emitted when there is an additional text delta. - - `"content_filter"` + - `stream_id: optional string` - - `instructions: string or array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more or null` + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - A system (or developer) message inserted into the model's context. + - `ResponseTextWsDone = ResponseTextDoneEvent` - When using along with `previous_response_id`, the instructions from a previous - response will not be carried over to the next response. This makes it simple - to swap out system (or developer) messages in new responses. + Emitted when text content is finalized. - - `string` + - `stream_id: optional string` - A text input to the model, equivalent to a text input with the - `developer` role. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `InputItemList = array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more` + - `ResponseWebSearchCallWsCompleted = ResponseWebSearchCallCompletedEvent` - A list of one or many input items to the model, containing - different content types. + Emitted when a web search call is completed. - - `EasyInputMessage object { content, role, phase, type }` + - `stream_id: optional string` - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. Messages with the - `assistant` role are presumed to have been generated by the model in previous - interactions. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `content: string or ResponseInputMessageContentList` + - `ResponseWebSearchCallInWsProgress = ResponseWebSearchCallInProgressEvent` - Text, image, or audio input to the model, used to generate a response. - Can also contain previous assistant responses. + Emitted when a web search call is initiated. - - `TextInput = string` + - `stream_id: optional string` - A text input to the model. + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. - - `ResponseInputMessageContentList = array of ResponseInputContent` + - `ResponseWebSearchCallWsSearching = ResponseWebSearchCallSearchingEvent` + + Emitted when a web search call is executing. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseImageGenCallWsCompleted = ResponseImageGenCallCompletedEvent` + + Emitted when an image generation tool call has completed and the final image is available. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseImageGenCallWsGenerating = ResponseImageGenCallGeneratingEvent` + + Emitted when an image generation tool call is actively generating an image (intermediate state). + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseImageGenCallInWsProgress = ResponseImageGenCallInProgressEvent` + + Emitted when an image generation tool call is in progress. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseImageGenCallPartialWsImage = ResponseImageGenCallPartialImageEvent` + + Emitted when a partial image is available during image generation streaming. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpCallArgumentsWsDelta = ResponseMcpCallArgumentsDeltaEvent` + + Emitted when there is a delta (partial update) to the arguments of an MCP tool call. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpCallArgumentsWsDone = ResponseMcpCallArgumentsDoneEvent` + + Emitted when the arguments for an MCP tool call are finalized. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpCallWsCompleted = ResponseMcpCallCompletedEvent` + + Emitted when an MCP tool call has completed successfully. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpCallWsFailed = ResponseMcpCallFailedEvent` + + Emitted when an MCP tool call has failed. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpCallInWsProgress = ResponseMcpCallInProgressEvent` + + Emitted when an MCP tool call is in progress. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpListToolsWsCompleted = ResponseMcpListToolsCompletedEvent` + + Emitted when the list of available MCP tools has been successfully retrieved. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpListToolsWsFailed = ResponseMcpListToolsFailedEvent` + + Emitted when the attempt to list available MCP tools has failed. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseMcpListToolsInWsProgress = ResponseMcpListToolsInProgressEvent` + + Emitted when the system is in the process of retrieving the list of available MCP tools. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseOutputTextAnnotationWsAdded = ResponseOutputTextAnnotationAddedEvent` + + Emitted when an annotation is added to output text content. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseWsQueued = ResponseQueuedEvent` + + Emitted when a response is queued and waiting to be processed. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseCustomToolCallInputWsDelta = ResponseCustomToolCallInputDeltaEvent` + + Event representing a delta (partial update) to the input of a custom tool call. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + + - `ResponseCustomToolCallInputWsDone = ResponseCustomToolCallInputDoneEvent` + + Event indicating that input for a custom tool call is complete. + + - `stream_id: optional string` + + The WebSocket lane that emitted this event. This field is present + when the originating `response.create` event supplied a + `stream_id`. + +### Skill Reference + +- `SkillReference object { skill_id, type, version }` + + - `skill_id: string` + + The ID of the referenced skill. + + - `type: "skill_reference"` + + References a skill created with the /v1/skills endpoint. + + - `"skill_reference"` + + - `version: optional string` + + Optional skill version. Use a positive integer or 'latest'. Omit for default. + +### Tool Choice Allowed + +- `ToolChoiceAllowed object { mode, tools, type }` + + Constrains the tools available to the model to a pre-defined set. + + - `mode: "auto" or "required"` + + Constrains the tools available to the model to a pre-defined set. + + `auto` allows the model to pick from among the allowed tools and generate a + message. + + `required` requires the model to call one or more of the allowed tools. + + - `"auto"` + + - `"required"` + + - `tools: array of map[unknown]` + + A list of tool definitions that the model should be allowed to call. + + For the Responses API, the list of tool definitions might look like: + + ```json + [ + { "type": "function", "name": "get_weather" }, + { "type": "mcp", "server_label": "deepwiki" }, + { "type": "image_generation" } + ] + ``` + + - `type: "allowed_tools"` + + Allowed tool configuration type. Always `allowed_tools`. + + - `"allowed_tools"` + +### Tool Choice Apply Patch + +- `ToolChoiceApplyPatch object { type }` + + Forces the model to call the apply_patch tool when executing a tool call. + + - `type: "apply_patch"` + + The tool to call. Always `apply_patch`. + + - `"apply_patch"` + +### Tool Choice Custom + +- `ToolChoiceCustom object { name, type }` + + Use this option to force the model to call a specific custom tool. + + - `name: string` + + The name of the custom tool to call. + + - `type: "custom"` + + For custom tool calling, the type is always `custom`. + + - `"custom"` + +### Tool Choice Function + +- `ToolChoiceFunction object { name, type }` + + Use this option to force the model to call a specific function. + + - `name: string` + + The name of the function to call. + + - `type: "function"` + + For function calling, the type is always `function`. + + - `"function"` + +### Tool Choice Mcp + +- `ToolChoiceMcp object { server_label, type, name }` + + Use this option to force the model to call a specific tool on a remote MCP server. + + - `server_label: string` + + The label of the MCP server to use. + + - `type: "mcp"` + + For MCP tools, the type is always `mcp`. + + - `"mcp"` + + - `name: optional string or null` + + The name of the tool to call on the server. + +### Tool Choice Options + +- `ToolChoiceOptions = "none" or "auto" or "required"` + + Controls which (if any) tool is called by the model. + + `none` means the model will not call any tool and instead generates a message. + + `auto` means the model can pick between generating a message or calling one or + more tools. + + `required` means the model must call one or more tools. + + - `"none"` + + - `"auto"` + + - `"required"` + +### Tool Choice Shell + +- `ToolChoiceShell object { type }` + + Forces the model to call the shell tool when a tool call is required. + + - `type: "shell"` + + The tool to call. Always `shell`. + + - `"shell"` + +### Tool Choice Types + +- `ToolChoiceTypes object { type }` + + Indicates that the model should use a built-in tool to generate a response. + [Learn more about built-in tools](/docs/guides/tools). + + - `type: "file_search" or "web_search_preview" or "computer" or 5 more` + + The type of hosted tool the model should to use. Learn more about + [built-in tools](/docs/guides/tools). + + Allowed values are: + + - `file_search` + - `web_search_preview` + - `computer` + - `computer_use_preview` + - `computer_use` + - `code_interpreter` + - `image_generation` + + - `"file_search"` + + - `"web_search_preview"` + + - `"computer"` + + - `"computer_use_preview"` + + - `"computer_use"` + + - `"web_search_preview_2025_03_11"` + + - `"image_generation"` + + - `"code_interpreter"` + +# Input Items + +## List input items + +**get** `/responses/{response_id}/input_items` + +Returns a list of input items for a given response. + +### Path Parameters + +- `response_id: string` + +### Query Parameters + +- `after: optional string` + + An item ID to list items after, used in pagination. + +- `include: optional array of ResponseIncludable` + + Additional fields to include in the response. See the `include` + parameter for Response creation above for more information. + + - `"file_search_call.results"` + + - `"web_search_call.results"` + + - `"web_search_call.action.sources"` + + - `"message.input_image.image_url"` + + - `"computer_call_output.output.image_url"` + + - `"code_interpreter_call.outputs"` + + - `"reasoning.encrypted_content"` + + - `"message.output_text.logprobs"` + +- `limit: optional number` + + A limit on the number of objects to be returned. Limit can range between + 1 and 100, and the default is 20. + +- `order: optional "asc" or "desc"` + + The order to return the input items in. Default is `desc`. + + - `asc`: Return the input items in ascending order. + - `desc`: Return the input items in descending order. + + - `"asc"` + + - `"desc"` + +### Returns + +- `ResponseItemList object { data, first_id, has_more, 2 more }` + + A list of Response items. + + - `data: array of ResponseInputMessageItem or ResponseOutputMessage or object { id, queries, status, 2 more } or 26 more` + + A list of items used to generate this response. + + - `ResponseInputMessageItem object { id, content, role, 2 more }` + + - `id: string` + + The unique ID of the message input. + + - `content: ResponseInputMessageContentList` A list of one or many input items to the model, containing different content types. @@ -142920,56 +143839,22 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"explicit"` - - `role: "user" or "assistant" or "system" or "developer"` + - `role: "user" or "system" or "developer"` - The role of the message input. One of `user`, `assistant`, `system`, or - `developer`. + The role of the message input. One of `user`, `system`, or `developer`. - `"user"` - - `"assistant"` - - `"system"` - `"developer"` - - `phase: optional "commentary" or "final_answer" or null` - - Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). - For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend - phase on all assistant messages — dropping it can degrade performance. Not used for user messages. - - - `"commentary"` - - - `"final_answer"` - - - `type: optional "message"` + - `type: "message"` - The type of the message input. Always `message`. + The type of the message input. Always set to `message`. - `"message"` - - `Message object { content, role, status, type }` - - A message input to the model with a role indicating instruction following - hierarchy. Instructions given with the `developer` or `system` role take - precedence over instructions given with the `user` role. - - - `content: ResponseInputMessageContentList` - - A list of one or many input items to the model, containing different content - types. - - - `role: "user" or "system" or "developer"` - - The role of the message input. One of `user`, `system`, or `developer`. - - - `"user"` - - - `"system"` - - - `"developer"` - - `status: optional "in_progress" or "completed" or "incomplete"` The status of item. One of `in_progress`, `completed`, or @@ -142981,12 +143866,6 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"incomplete"` - - `type: optional "message"` - - The type of the message input. Always set to `message`. - - - `"message"` - - `ResponseOutputMessage object { id, content, role, 3 more }` An output message from the model. @@ -143526,9 +144405,11 @@ curl https://api.openai.com/v1/responses/resp_123 \ A wait action. - - `ComputerCallOutput object { call_id, output, type, 3 more }` + - `ComputerCallOutput object { id, call_id, output, 4 more }` - The output of a computer tool call. + - `id: string` + + The unique ID of the computer call tool output. - `call_id: string` @@ -143553,19 +144434,29 @@ curl https://api.openai.com/v1/responses/resp_123 \ The URL of the screenshot image. + - `status: "completed" or "incomplete" or "failed" or "in_progress"` + + The status of the message input. One of `in_progress`, `completed`, or + `incomplete`. Populated when input items are returned via API. + + - `"completed"` + + - `"incomplete"` + + - `"failed"` + + - `"in_progress"` + - `type: "computer_call_output"` The type of the computer tool call output. Always `computer_call_output`. - `"computer_call_output"` - - `id: optional string or null` - - The ID of the computer tool call output. - - - `acknowledged_safety_checks: optional array of object { id, code, message } or null` + - `acknowledged_safety_checks: optional array of object { id, code, message }` - The safety checks reported by the API that have been acknowledged by the developer. + The safety checks reported by the API that have been acknowledged by the + developer. - `id: string` @@ -143579,15 +144470,9 @@ curl https://api.openai.com/v1/responses/resp_123 \ Details about the pending safety check. - - `status: optional "in_progress" or "completed" or "incomplete" or null` - - The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. - - - `"in_progress"` - - - `"completed"` + - `created_by: optional string` - - `"incomplete"` + The identifier of the actor that created the item. - `WebSearchCall object { id, action, status, type }` @@ -143685,10 +144570,11 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_call"` - - `FunctionCall object { arguments, call_id, name, 5 more }` + - `FunctionCall object { id, arguments, call_id, 6 more }` - A tool call to run a function. See the - [function calling guide](/docs/guides/function-calling) for more information. + - `id: string` + + The unique ID of the function tool call. - `arguments: string` @@ -143702,16 +144588,23 @@ curl https://api.openai.com/v1/responses/resp_123 \ The name of the function to run. + - `status: "in_progress" or "completed" or "incomplete"` + + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. + + - `"in_progress"` + + - `"completed"` + + - `"incomplete"` + - `type: "function_call"` The type of the function tool call. Always `function_call`. - `"function_call"` - - `id: optional string` - - The unique ID of the function tool call. - - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -143732,146 +144625,55 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"program"` - - `namespace: optional string` - - The namespace of the function to run. - - - `status: optional "in_progress" or "completed" or "incomplete"` + - `created_by: optional string` - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. + The identifier of the actor that created the item. - - `"in_progress"` + - `namespace: optional string` - - `"completed"` + The namespace of the function to run. - - `"incomplete"` + - `FunctionCallOutput object { id, output, status, 6 more }` - - `FunctionCallOutput object { output, type, id, 5 more }` + - `id: string` - The output of a function tool call. + The unique ID of the function call tool output. - - `output: string or array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent` + - `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile` - Text, image, or file output of the function tool call. + The output from the function call generated by your code. + Can be a string or an list of output content. - - `string` + - `StringOutput = string` - A JSON string of the output of the function tool call. + A string of the output of the function call. - - `array of ResponseInputTextContent or ResponseInputImageContent or ResponseInputFileContent` + - `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile` - An array of content outputs (text, image, file) for the function tool call. + Text, image, or file output of the function call. - - `ResponseInputTextContent object { text, type, prompt_cache_breakpoint }` + - `ResponseInputText object { text, type, prompt_cache_breakpoint }` A text input to the model. - - `text: string` - - The text input to the model. - - - `type: "input_text"` - - The type of the input item. Always `input_text`. - - - `"input_text"` - - - `prompt_cache_breakpoint: optional object { mode } or null` - - Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block. - - - `mode: "explicit"` - - The breakpoint mode. Always `explicit`. - - - `"explicit"` - - - `ResponseInputImageContent object { type, detail, file_id, 2 more }` - - An image input to the model. Learn about [image inputs](/docs/guides/vision) - - - `type: "input_image"` - - The type of the input item. Always `input_image`. - - - `"input_image"` - - - `detail: optional "low" or "high" or "auto" or "original" or null` - - The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. - - - `"low"` - - - `"high"` - - - `"auto"` - - - `"original"` - - - `file_id: optional string or null` - - The ID of the file to be sent to the model. - - - `image_url: optional string or null` - - The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. - - - `prompt_cache_breakpoint: optional object { mode } or null` - - Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block. - - - `mode: "explicit"` - - The breakpoint mode. Always `explicit`. + - `ResponseInputImage object { detail, type, file_id, 2 more }` - - `"explicit"` + An image input to the model. Learn about [image inputs](/docs/guides/vision). - - `ResponseInputFileContent object { type, detail, file_data, 4 more }` + - `ResponseInputFile object { type, detail, file_data, 4 more }` A file input to the model. - - `type: "input_file"` - - The type of the input item. Always `input_file`. - - - `"input_file"` - - - `detail: optional "auto" or "low" or "high"` - - The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`. - - - `"auto"` - - - `"low"` - - - `"high"` - - - `file_data: optional string or null` - - The base64-encoded data of the file to be sent to the model. - - - `file_id: optional string or null` - - The ID of the file to be sent to the model. - - - `file_url: optional string or null` - - The URL of the file to be sent to the model. - - - `filename: optional string or null` - - The name of the file to be sent to the model. - - - `prompt_cache_breakpoint: optional object { mode } or null` + - `status: "in_progress" or "completed" or "incomplete"` - Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block. + The status of the item. One of `in_progress`, `completed`, or + `incomplete`. Populated when items are returned via API. - - `mode: "explicit"` + - `"in_progress"` - The breakpoint mode. Always `explicit`. + - `"completed"` - - `"explicit"` + - `"incomplete"` - `type: "function_call_output"` @@ -143879,11 +144681,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"function_call_output"` - - `id: optional string or null` - - The unique ID of the function tool call output. Populated when this item is returned via API. - - - `call_id: optional string or null` + - `call_id: optional string` The unique ID of the function tool call generated by the model. @@ -143911,17 +144709,43 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"program"` - - `name: optional string or null` + - `created_by: optional string` + + The identifier of the actor that created the item. + + - `name: optional string` The name of the tool that produced the output. - - `namespace: optional string or null` + - `namespace: optional string` The namespace of the tool that produced the output. - - `status: optional "in_progress" or "completed" or "incomplete" or null` + - `ToolSearchCall object { id, arguments, call_id, 4 more }` - The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. + - `id: string` + + The unique ID of the tool search call item. + + - `arguments: unknown` + + Arguments used for the tool search call. + + - `call_id: string or null` + + The unique ID of the tool search call generated by the model. + + - `execution: "server" or "client"` + + Whether tool search was executed by the server or by the client. + + - `"server"` + + - `"client"` + + - `status: "in_progress" or "completed" or "incomplete"` + + The status of the tool search call item that was recorded. - `"in_progress"` @@ -143929,27 +144753,27 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"incomplete"` - - `ToolSearchCall object { arguments, type, id, 3 more }` + - `type: "tool_search_call"` - - `arguments: unknown` + The type of the item. Always `tool_search_call`. - The arguments supplied to the tool search call. + - `"tool_search_call"` - - `type: "tool_search_call"` + - `created_by: optional string` - The item type. Always `tool_search_call`. + The identifier of the actor that created the item. - - `"tool_search_call"` + - `ToolSearchOutput object { id, call_id, execution, 4 more }` - - `id: optional string or null` + - `id: string` - The unique ID of this tool search call. + The unique ID of the tool search output item. - - `call_id: optional string or null` + - `call_id: string or null` The unique ID of the tool search call generated by the model. - - `execution: optional "server" or "client"` + - `execution: "server" or "client"` Whether tool search was executed by the server or by the client. @@ -143957,9 +144781,9 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"client"` - - `status: optional "in_progress" or "completed" or "incomplete" or null` + - `status: "in_progress" or "completed" or "incomplete"` - The status of the tool search call. + The status of the tool search output item that was recorded. - `"in_progress"` @@ -143967,11 +144791,9 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"incomplete"` - - `ToolSearchOutput object { tools, type, id, 3 more }` - - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more` - The loaded tool definitions returned by the tool search output. + The loaded tool definitions returned by tool search. - `Function object { name, parameters, strict, 5 more }` @@ -144182,7 +145004,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -144195,6 +145017,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -145033,47 +145859,43 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "tool_search_output"` - The item type. Always `tool_search_output`. + The type of the item. Always `tool_search_output`. - `"tool_search_output"` - - `id: optional string or null` - - The unique ID of this tool search output. - - - `call_id: optional string or null` - - The unique ID of the tool search call generated by the model. + - `created_by: optional string` - - `execution: optional "server" or "client"` + The identifier of the actor that created the item. - Whether tool search was executed by the server or by the client. + - `AdditionalTools object { id, role, tools, type }` - - `"server"` + - `id: string` - - `"client"` + The unique ID of the additional tools item. - - `status: optional "in_progress" or "completed" or "incomplete" or null` + - `role: "unknown" or "user" or "assistant" or 5 more` - The status of the tool search output. + The role that provided the additional tools. - - `"in_progress"` + - `"unknown"` - - `"completed"` + - `"user"` - - `"incomplete"` + - `"assistant"` - - `AdditionalTools object { role, tools, type, id }` + - `"system"` - - `role: "developer"` + - `"critic"` - The role that provided the additional tools. Only `developer` is supported. + - `"discriminator"` - `"developer"` + - `"tool"` + - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more` - A list of additional tools made available at this item. + The additional tool definitions made available at this item. - `Function object { name, parameters, strict, 5 more }` @@ -145217,7 +146039,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -145230,6 +146052,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -145886,14 +146712,10 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "additional_tools"` - The item type. Always `additional_tools`. + The type of the item. Always `additional_tools`. - `"additional_tools"` - - `id: optional string or null` - - The unique ID of this additional tools item. - - `Reasoning object { id, summary, type, 3 more }` A description of the chain of thought used by a reasoning model while generating @@ -145956,13 +146778,69 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"incomplete"` - - `Compaction object { encrypted_content, type, id }` + - `Program object { id, call_id, code, 2 more }` + + - `id: string` + + The unique ID of the program item. + + - `call_id: string` + + The stable call ID of the program item. + + - `code: string` + + The JavaScript source executed by programmatic tool calling. + + - `fingerprint: string` + + Opaque program replay fingerprint that must be round-tripped. + + - `type: "program"` + + The type of the item. Always `program`. + + - `"program"` + + - `ProgramOutput object { id, call_id, result, 2 more }` + + - `id: string` + + The unique ID of the program output item. + + - `call_id: string` + + The call ID of the program item. + + - `result: string` + + The result produced by the program item. + + - `status: "completed" or "incomplete"` + + The terminal status of the program output item. + + - `"completed"` + + - `"incomplete"` + + - `type: "program_output"` + + The type of the item. Always `program_output`. + + - `"program_output"` + + - `Compaction object { id, encrypted_content, type, created_by }` A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). + - `id: string` + + The unique ID of the compaction item. + - `encrypted_content: string` - The encrypted content of the compaction summary. + The encrypted content that was produced by compaction. - `type: "compaction"` @@ -145970,9 +146848,9 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"compaction"` - - `id: optional string or null` + - `created_by: optional string` - The ID of the compaction item. + The identifier of the actor that created the item. - `ImageGenerationCall object { id, result, status, type }` @@ -146159,9 +147037,13 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"incomplete"` - - `ShellCall object { action, call_id, type, 4 more }` + - `ShellCall object { id, action, call_id, 5 more }` - A tool representing a request to execute one or more shell commands. + A tool call that executes one or more shell commands in a managed environment. + + - `id: string` + + The unique ID of the shell tool call. Populated when this item is returned via API. - `action: object { commands, max_output_length, timeout_ms }` @@ -146169,30 +147051,60 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `commands: array of string` - Ordered shell commands for the execution environment to run. - - - `max_output_length: optional number or null` + - `max_output_length: number or null` - Maximum number of UTF-8 characters to capture from combined stdout and stderr output. + Optional maximum number of characters to return from each command. - - `timeout_ms: optional number or null` + - `timeout_ms: number or null` - Maximum wall-clock time in milliseconds to allow the shell commands to run. + Optional timeout in milliseconds for the commands. - `call_id: string` The unique ID of the shell tool call generated by the model. + - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` + + Represents the use of a local environment to perform shell actions. + + - `ResponseLocalEnvironment object { type }` + + Represents the use of a local environment to perform shell actions. + + - `type: "local"` + + The environment type. Always `local`. + + - `"local"` + + - `ResponseContainerReference object { container_id, type }` + + Represents a container created with /v1/containers. + + - `container_id: string` + + - `type: "container_reference"` + + The environment type. Always `container_reference`. + + - `"container_reference"` + + - `status: "in_progress" or "completed" or "incomplete"` + + The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + + - `"in_progress"` + + - `"completed"` + + - `"incomplete"` + - `type: "shell_call"` The type of the item. Always `shell_call`. - `"shell_call"` - - `id: optional string or null` - - The unique ID of the shell tool call. Populated when this item is returned via API. - - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -146201,8 +147113,6 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "direct"` - The caller type. Always `direct`. - - `"direct"` - `Program object { caller_id, type }` @@ -146213,43 +147123,35 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "program"` - The caller type. Always `program`. - - `"program"` - - `environment: optional LocalEnvironment or ContainerReference or null` - - The environment to execute the shell commands in. - - - `LocalEnvironment object { type, skills }` - - - `ContainerReference object { container_id, type }` - - - `status: optional "in_progress" or "completed" or "incomplete" or null` - - The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. + - `created_by: optional string` - - `"in_progress"` + The ID of the entity that created this tool call. - - `"completed"` + - `ShellCallOutput object { id, call_id, max_output_length, 5 more }` - - `"incomplete"` + The output of a shell tool call that was emitted. - - `ShellCallOutput object { call_id, output, type, 4 more }` + - `id: string` - The streamed output items emitted by a shell tool call. + The unique ID of the shell call output. Populated when this item is returned via API. - `call_id: string` The unique ID of the shell tool call generated by the model. - - `output: array of ResponseFunctionShellCallOutputContent` + - `max_output_length: number or null` - Captured chunks of stdout and stderr output, along with their associated outcomes. + The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. + + - `output: array of object { outcome, stderr, stdout, created_by }` + + An array of shell call output contents - `outcome: object { type } or object { exit_code, type }` - The exit or timeout outcome associated with this shell call. + Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. - `Timeout object { type }` @@ -146267,7 +147169,7 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `exit_code: number` - The exit code returned by the shell process. + Exit code from the shell process. - `type: "exit"` @@ -146277,21 +147179,31 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `stderr: string` - Captured stderr output for the shell call. + The standard error output that was captured. - `stdout: string` - Captured stdout output for the shell call. + The standard output that was captured. - - `type: "shell_call_output"` + - `created_by: optional string` - The type of the item. Always `shell_call_output`. + The identifier of the actor that created the item. - - `"shell_call_output"` + - `status: "in_progress" or "completed" or "incomplete"` - - `id: optional string or null` + The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. - The unique ID of the shell tool call output. Populated when this item is returned via API. + - `"in_progress"` + + - `"completed"` + + - `"incomplete"` + + - `type: "shell_call_output"` + + The type of the shell call output. Always `shell_call_output`. + + - `"shell_call_output"` - `caller: optional object { type } or object { caller_id, type } or null` @@ -146301,8 +147213,6 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "direct"` - The caller type. Always `direct`. - - `"direct"` - `Program object { caller_id, type }` @@ -146313,27 +147223,19 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "program"` - The caller type. Always `program`. - - `"program"` - - `max_output_length: optional number or null` - - The maximum number of UTF-8 characters captured for this shell call's combined output. - - - `status: optional "in_progress" or "completed" or "incomplete" or null` - - The status of the shell call output. + - `created_by: optional string` - - `"in_progress"` + The identifier of the actor that created the item. - - `"completed"` + - `ApplyPatchCall object { id, call_id, operation, 4 more }` - - `"incomplete"` + A tool call that applies file diffs by creating, deleting, or updating files. - - `ApplyPatchCall object { call_id, operation, status, 3 more }` + - `id: string` - A tool call representing a request to create, delete, or update files using diff patches. + The unique ID of the apply patch tool call. Populated when this item is returned via API. - `call_id: string` @@ -146341,55 +147243,55 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }` - The specific create, delete, or update instruction for the apply_patch tool call. + One of the create_file, delete_file, or update_file operations applied via apply_patch. - `CreateFile object { diff, path, type }` - Instruction for creating a new file via the apply_patch tool. + Instruction describing how to create a file via the apply_patch tool. - `diff: string` - Unified diff content to apply when creating the file. + Diff to apply. - `path: string` - Path of the file to create relative to the workspace root. + Path of the file to create. - `type: "create_file"` - The operation type. Always `create_file`. + Create a new file with the provided diff. - `"create_file"` - `DeleteFile object { path, type }` - Instruction for deleting an existing file via the apply_patch tool. + Instruction describing how to delete a file via the apply_patch tool. - `path: string` - Path of the file to delete relative to the workspace root. + Path of the file to delete. - `type: "delete_file"` - The operation type. Always `delete_file`. + Delete the specified file. - `"delete_file"` - `UpdateFile object { diff, path, type }` - Instruction for updating an existing file via the apply_patch tool. + Instruction describing how to update a file via the apply_patch tool. - `diff: string` - Unified diff content to apply to the existing file. + Diff to apply. - `path: string` - Path of the file to update relative to the workspace root. + Path of the file to update. - `type: "update_file"` - The operation type. Always `update_file`. + Update an existing file with the provided diff. - `"update_file"` @@ -146407,10 +147309,6 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"apply_patch_call"` - - `id: optional string or null` - - The unique ID of the apply patch tool call. Populated when this item is returned via API. - - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -146419,8 +147317,6 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "direct"` - The caller type. Always `direct`. - - `"direct"` - `Program object { caller_id, type }` @@ -146431,13 +147327,19 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "program"` - The caller type. Always `program`. - - `"program"` - - `ApplyPatchCallOutput object { call_id, status, type, 3 more }` + - `created_by: optional string` - The streamed output emitted by an apply patch tool call. + The ID of the entity that created this tool call. + + - `ApplyPatchCallOutput object { id, call_id, status, 4 more }` + + The output emitted by an apply patch tool call. + + - `id: string` + + The unique ID of the apply patch tool call output. Populated when this item is returned via API. - `call_id: string` @@ -146457,10 +147359,6 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `"apply_patch_call_output"` - - `id: optional string or null` - - The unique ID of the apply patch tool call output. Populated when this item is returned via API. - - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -146469,8 +147367,6 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "direct"` - The caller type. Always `direct`. - - `"direct"` - `Program object { caller_id, type }` @@ -146481,10464 +147377,15 @@ curl https://api.openai.com/v1/responses/resp_123 \ - `type: "program"` - The caller type. Always `program`. - - `"program"` + - `created_by: optional string` + + The ID of the entity that created this tool call output. + - `output: optional string or null` - Optional human-readable log text from the apply patch tool (e.g., patch results or errors). - - - `McpListTools object { id, server_label, tools, 2 more }` - - A list of tools available on an MCP server. - - - `id: string` - - The unique ID of the list. - - - `server_label: string` - - The label of the MCP server. - - - `tools: array of object { input_schema, name, annotations, description }` - - The tools available on the server. - - - `input_schema: unknown` - - The JSON schema describing the tool's input. - - - `name: string` - - The name of the tool. - - - `annotations: optional unknown or null` - - Additional annotations about the tool. - - - `description: optional string or null` - - The description of the tool. - - - `type: "mcp_list_tools"` - - The type of the item. Always `mcp_list_tools`. - - - `"mcp_list_tools"` - - - `error: optional string or null` - - Error message if the server could not list tools. - - - `McpApprovalRequest object { id, arguments, name, 2 more }` - - A request for human approval of a tool invocation. - - - `id: string` - - The unique ID of the approval request. - - - `arguments: string` - - A JSON string of arguments for the tool. - - - `name: string` - - The name of the tool to run. - - - `server_label: string` - - The label of the MCP server making the request. - - - `type: "mcp_approval_request"` - - The type of the item. Always `mcp_approval_request`. - - - `"mcp_approval_request"` - - - `McpApprovalResponse object { approval_request_id, approve, type, 2 more }` - - A response to an MCP approval request. - - - `approval_request_id: string` - - The ID of the approval request being answered. - - - `approve: boolean` - - Whether the request was approved. - - - `type: "mcp_approval_response"` - - The type of the item. Always `mcp_approval_response`. - - - `"mcp_approval_response"` - - - `id: optional string or null` - - The unique ID of the approval response - - - `reason: optional string or null` - - Optional reason for the decision. - - - `McpCall object { id, arguments, name, 6 more }` - - An invocation of a tool on an MCP server. - - - `id: string` - - The unique ID of the tool call. - - - `arguments: string` - - A JSON string of the arguments passed to the tool. - - - `name: string` - - The name of the tool that was run. - - - `server_label: string` - - The label of the MCP server running the tool. - - - `type: "mcp_call"` - - The type of the item. Always `mcp_call`. - - - `"mcp_call"` - - - `approval_request_id: optional string or null` - - Unique identifier for the MCP tool call approval request. - Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. - - - `error: optional string or null` - - The error from the tool call, if any. - - - `output: optional string or null` - - The output from the tool call. - - - `status: optional "in_progress" or "completed" or "incomplete" or 2 more` - - The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `"calling"` - - - `"failed"` - - - `CustomToolCallOutput object { call_id, output, type, 2 more }` - - The output of a custom tool call from your code, being sent back to the model. - - - `call_id: string` - - The call ID, used to map this custom tool call output to a custom tool call. - - - `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - - - `StringOutput = string` - - A string of the output of the custom tool call. - - - `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - Text, image, or file output of the custom tool call. - - - `ResponseInputText object { text, type, prompt_cache_breakpoint }` - - A text input to the model. - - - `ResponseInputImage object { detail, type, file_id, 2 more }` - - An image input to the model. Learn about [image inputs](/docs/guides/vision). - - - `ResponseInputFile object { type, detail, file_data, 4 more }` - - A file input to the model. - - - `type: "custom_tool_call_output"` - - The type of the custom tool call output. Always `custom_tool_call_output`. - - - `"custom_tool_call_output"` - - - `id: optional string` - - The unique ID of the custom tool call output in the OpenAI platform. - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - The caller type. Always `direct`. - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - The caller type. Always `program`. - - - `"program"` - - - `CustomToolCall object { call_id, input, name, 4 more }` - - A call to a custom tool created by the model. - - - `call_id: string` - - An identifier used to map this custom tool call to a tool call output. - - - `input: string` - - The input for the custom tool call generated by the model. - - - `name: string` - - The name of the custom tool being called. - - - `type: "custom_tool_call"` - - The type of the custom tool call. Always `custom_tool_call`. - - - `"custom_tool_call"` - - - `id: optional string` - - The unique ID of the custom tool call in the OpenAI platform. - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `namespace: optional string` - - The namespace of the custom tool being called. - - - `CompactionTrigger object { type }` - - Compacts the current context. Must be the final input item. - - - `type: "compaction_trigger"` - - The type of the item. Always `compaction_trigger`. - - - `"compaction_trigger"` - - - `ItemReference object { id, type }` - - An internal identifier for an item to reference. - - - `id: string` - - The ID of the item to reference. - - - `type: optional "item_reference" or null` - - The type of item to reference. Always `item_reference`. - - - `"item_reference"` - - - `Program object { id, call_id, code, 2 more }` - - - `id: string` - - The unique ID of this program item. - - - `call_id: string` - - The stable call ID of the program item. - - - `code: string` - - The JavaScript source executed by programmatic tool calling. - - - `fingerprint: string` - - Opaque program replay fingerprint that must be round-tripped. - - - `type: "program"` - - The item type. Always `program`. - - - `"program"` - - - `ProgramOutput object { id, call_id, result, 2 more }` - - - `id: string` - - The unique ID of this program output item. - - - `call_id: string` - - The call ID of the program item. - - - `result: string` - - The result produced by the program item. - - - `status: "completed" or "incomplete"` - - The terminal status of the program output. - - - `"completed"` - - - `"incomplete"` - - - `type: "program_output"` - - The item type. Always `program_output`. - - - `"program_output"` - - - `metadata: Metadata or null` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. - - Keys are strings with a maximum length of 64 characters. Values are strings - with a maximum length of 512 characters. - - - `model: ResponsesModel` - - 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](/docs/models) - to browse and compare available models. - - - `string` - - - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 79 more` - - - `"gpt-5.6-sol"` - - - `"gpt-5.6-terra"` - - - `"gpt-5.6-luna"` - - - `"gpt-5.5"` - - - `"gpt-5.4"` - - - `"gpt-5.4-mini"` - - - `"gpt-5.4-nano"` - - - `"gpt-5.4-mini-2026-03-17"` - - - `"gpt-5.4-nano-2026-03-17"` - - - `"gpt-5.3-chat-latest"` - - - `"gpt-5.2"` - - - `"gpt-5.2-2025-12-11"` - - - `"gpt-5.2-chat-latest"` - - - `"gpt-5.2-pro"` - - - `"gpt-5.2-pro-2025-12-11"` - - - `"gpt-5.1"` - - - `"gpt-5.1-2025-11-13"` - - - `"gpt-5.1-codex"` - - - `"gpt-5.1-mini"` - - - `"gpt-5.1-chat-latest"` - - - `"gpt-5"` - - - `"gpt-5-mini"` - - - `"gpt-5-nano"` - - - `"gpt-5-2025-08-07"` - - - `"gpt-5-mini-2025-08-07"` - - - `"gpt-5-nano-2025-08-07"` - - - `"gpt-5-chat-latest"` - - - `"gpt-4.1"` - - - `"gpt-4.1-mini"` - - - `"gpt-4.1-nano"` - - - `"gpt-4.1-2025-04-14"` - - - `"gpt-4.1-mini-2025-04-14"` - - - `"gpt-4.1-nano-2025-04-14"` - - - `"o4-mini"` - - - `"o4-mini-2025-04-16"` - - - `"o3"` - - - `"o3-2025-04-16"` - - - `"o3-mini"` - - - `"o3-mini-2025-01-31"` - - - `"o1"` - - - `"o1-2024-12-17"` - - - `"o1-preview"` - - - `"o1-preview-2024-09-12"` - - - `"o1-mini"` - - - `"o1-mini-2024-09-12"` - - - `"gpt-4o"` - - - `"gpt-4o-2024-11-20"` - - - `"gpt-4o-2024-08-06"` - - - `"gpt-4o-2024-05-13"` - - - `"gpt-4o-audio-preview"` - - - `"gpt-4o-audio-preview-2024-10-01"` - - - `"gpt-4o-audio-preview-2024-12-17"` - - - `"gpt-4o-audio-preview-2025-06-03"` - - - `"gpt-4o-mini-audio-preview"` - - - `"gpt-4o-mini-audio-preview-2024-12-17"` - - - `"gpt-4o-search-preview"` - - - `"gpt-4o-mini-search-preview"` - - - `"gpt-4o-search-preview-2025-03-11"` - - - `"gpt-4o-mini-search-preview-2025-03-11"` - - - `"chatgpt-4o-latest"` - - - `"codex-mini-latest"` - - - `"gpt-4o-mini"` - - - `"gpt-4o-mini-2024-07-18"` - - - `"gpt-4-turbo"` - - - `"gpt-4-turbo-2024-04-09"` - - - `"gpt-4-0125-preview"` - - - `"gpt-4-turbo-preview"` - - - `"gpt-4-1106-preview"` - - - `"gpt-4-vision-preview"` - - - `"gpt-4"` - - - `"gpt-4-0314"` - - - `"gpt-4-0613"` - - - `"gpt-4-32k"` - - - `"gpt-4-32k-0314"` - - - `"gpt-4-32k-0613"` - - - `"gpt-3.5-turbo"` - - - `"gpt-3.5-turbo-16k"` - - - `"gpt-3.5-turbo-0301"` - - - `"gpt-3.5-turbo-0613"` - - - `"gpt-3.5-turbo-1106"` - - - `"gpt-3.5-turbo-0125"` - - - `"gpt-3.5-turbo-16k-0613"` - - - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 14 more` - - - `"o1-pro"` - - - `"o1-pro-2025-03-19"` - - - `"o3-pro"` - - - `"o3-pro-2025-06-10"` - - - `"o3-deep-research"` - - - `"o3-deep-research-2025-06-26"` - - - `"o4-mini-deep-research"` - - - `"o4-mini-deep-research-2025-06-26"` - - - `"computer-use-preview"` - - - `"computer-use-preview-2025-03-11"` - - - `"gpt-5-codex"` - - - `"gpt-5-pro"` - - - `"gpt-5-pro-2025-10-06"` - - - `"gpt-5.1-codex-max"` - - - `"gpt-daybreak-blue-latest"` - - - `"gpt-daybreak-red-latest"` - - - `"gpt-5.6-cyber"` - - - `object: "response"` - - The object type of this resource - always set to `response`. - - - `"response"` - - - `output: array of ResponseOutputItem` - - An array of content items generated by the model. - - - The length and order of items in the `output` array is dependent - on the model's response. - - Rather than accessing the first item in the `output` array and - assuming it's an `assistant` message with the content generated by - the model, you might consider using the `output_text` property where - supported in SDKs. - - - `ResponseOutputMessage object { id, content, role, 3 more }` - - An output message from the model. - - - `FileSearchCall object { id, queries, status, 2 more }` - - The results of a file search tool call. See the - [file search guide](/docs/guides/tools-file-search) for more information. - - - `id: string` - - The unique ID of the file search tool call. - - - `queries: array of string` - - The queries used to search for files. - - - `status: "in_progress" or "searching" or "completed" or 2 more` - - The status of the file search tool call. One of `in_progress`, - `searching`, `incomplete` or `failed`, - - - `"in_progress"` - - - `"searching"` - - - `"completed"` - - - `"incomplete"` - - - `"failed"` - - - `type: "file_search_call"` - - The type of the file search tool call. Always `file_search_call`. - - - `"file_search_call"` - - - `results: optional array of object { attributes, file_id, filename, 2 more } or null` - - The results of the file search tool call. - - - `attributes: optional map[string or number or boolean] or null` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. Keys are strings - with a maximum length of 64 characters. Values are strings with a maximum - length of 512 characters, booleans, or numbers. - - - `string` - - - `number` - - - `boolean` - - - `file_id: optional string` - - The unique ID of the file. - - - `filename: optional string` - - The name of the file. - - - `score: optional number` - - The relevance score of the file - a value between 0 and 1. - - - `text: optional string` - - The text that was retrieved from the file. - - - `FunctionCall object { arguments, call_id, name, 5 more }` - - A tool call to run a function. See the - [function calling guide](/docs/guides/function-calling) for more information. - - - `arguments: string` - - A JSON string of the arguments to pass to the function. - - - `call_id: string` - - The unique ID of the function tool call generated by the model. - - - `name: string` - - The name of the function to run. - - - `type: "function_call"` - - The type of the function tool call. Always `function_call`. - - - `"function_call"` - - - `id: optional string` - - The unique ID of the function tool call. - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `namespace: optional string` - - The namespace of the function to run. - - - `status: optional "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `FunctionCallOutput object { id, output, status, 6 more }` - - - `id: string` - - The unique ID of the function call tool output. - - - `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - The output from the function call generated by your code. - Can be a string or an list of output content. - - - `StringOutput = string` - - A string of the output of the function call. - - - `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - Text, image, or file output of the function call. - - - `ResponseInputText object { text, type, prompt_cache_breakpoint }` - - A text input to the model. - - - `ResponseInputImage object { detail, type, file_id, 2 more }` - - An image input to the model. Learn about [image inputs](/docs/guides/vision). - - - `ResponseInputFile object { type, detail, file_data, 4 more }` - - A file input to the model. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "function_call_output"` - - The type of the function tool call output. Always `function_call_output`. - - - `"function_call_output"` - - - `call_id: optional string` - - The unique ID of the function tool call generated by the model. - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - The caller type. Always `direct`. - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - The caller type. Always `program`. - - - `"program"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `name: optional string` - - The name of the tool that produced the output. - - - `namespace: optional string` - - The namespace of the tool that produced the output. - - - `WebSearchCall object { id, action, status, type }` - - The results of a web search tool call. See the - [web search guide](/docs/guides/tools-web-search) for more information. - - - `id: string` - - The unique ID of the web search tool call. - - - `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }` - - An object describing the specific action taken in this web search call. - Includes details on how the model used the web (search, open_page, find_in_page). - - - `Search object { type, queries, query, sources }` - - Action type "search" - Performs a web search query. - - - `type: "search"` - - The action type. - - - `"search"` - - - `queries: optional array of string` - - The search queries. - - - `query: optional string` - - The search query. - - - `sources: optional array of object { type, url }` - - The sources used in the search. - - - `type: "url"` - - The type of source. Always `url`. - - - `"url"` - - - `url: string` - - The URL of the source. - - - `OpenPage object { type, url }` - - Action type "open_page" - Opens a specific URL from search results. - - - `type: "open_page"` - - The action type. - - - `"open_page"` - - - `url: optional string or null` - - The URL opened by the model. - - - `FindInPage object { pattern, type, url }` - - Action type "find_in_page": Searches for a pattern within a loaded page. - - - `pattern: string` - - The pattern or text to search for within the page. - - - `type: "find_in_page"` - - The action type. - - - `"find_in_page"` - - - `url: string` - - The URL of the page searched for the pattern. - - - `status: "in_progress" or "searching" or "completed" or "failed"` - - The status of the web search tool call. - - - `"in_progress"` - - - `"searching"` - - - `"completed"` - - - `"failed"` - - - `type: "web_search_call"` - - The type of the web search tool call. Always `web_search_call`. - - - `"web_search_call"` - - - `ComputerCall object { id, call_id, pending_safety_checks, 4 more }` - - A tool call to a computer use tool. See the - [computer use guide](/docs/guides/tools-computer-use) for more information. - - - `id: string` - - The unique ID of the computer call. - - - `call_id: string` - - An identifier used when responding to the tool call with output. - - - `pending_safety_checks: array of object { id, code, message }` - - The pending safety checks for the computer call. - - - `id: string` - - The ID of the pending safety check. - - - `code: optional string or null` - - The type of the pending safety check. - - - `message: optional string or null` - - Details about the pending safety check. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "computer_call"` - - The type of the computer call. Always `computer_call`. - - - `"computer_call"` - - - `action: optional ComputerAction` - - A click action. - - - `actions: optional ComputerActionList` - - Flattened batched actions for `computer_use`. Each action includes an - `type` discriminator and action-specific fields. - - - `ComputerCallOutput object { id, call_id, output, 4 more }` - - - `id: string` - - The unique ID of the computer call tool output. - - - `call_id: string` - - The ID of the computer tool call that produced the output. - - - `output: ResponseComputerToolCallOutputScreenshot` - - A computer screenshot image used with the computer use tool. - - - `status: "completed" or "incomplete" or "failed" or "in_progress"` - - The status of the message input. One of `in_progress`, `completed`, or - `incomplete`. Populated when input items are returned via API. - - - `"completed"` - - - `"incomplete"` - - - `"failed"` - - - `"in_progress"` - - - `type: "computer_call_output"` - - The type of the computer tool call output. Always `computer_call_output`. - - - `"computer_call_output"` - - - `acknowledged_safety_checks: optional array of object { id, code, message }` - - The safety checks reported by the API that have been acknowledged by the - developer. - - - `id: string` - - The ID of the pending safety check. - - - `code: optional string or null` - - The type of the pending safety check. - - - `message: optional string or null` - - Details about the pending safety check. - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `Reasoning object { id, summary, type, 3 more }` - - 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](/docs/guides/conversation-state). - - - `id: string` - - The unique identifier of the reasoning content. - - - `summary: array of SummaryTextContent` - - Reasoning summary content. - - - `text: string` - - A summary of the reasoning output from the model so far. - - - `type: "summary_text"` - - The type of the object. Always `summary_text`. - - - `type: "reasoning"` - - The type of the object. Always `reasoning`. - - - `"reasoning"` - - - `content: optional array of object { text, type }` - - Reasoning text content. - - - `text: string` - - The reasoning text from the model. - - - `type: "reasoning_text"` - - The type of the reasoning text. Always `reasoning_text`. - - - `"reasoning_text"` - - - `encrypted_content: optional string or null` - - The encrypted content of the reasoning item. This is populated by default - for reasoning items returned by `POST /v1/responses` and WebSocket - `response.create` requests. - - - `status: optional "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `Program object { id, call_id, code, 2 more }` - - - `id: string` - - The unique ID of the program item. - - - `call_id: string` - - The stable call ID of the program item. - - - `code: string` - - The JavaScript source executed by programmatic tool calling. - - - `fingerprint: string` - - Opaque program replay fingerprint that must be round-tripped. - - - `type: "program"` - - The type of the item. Always `program`. - - - `"program"` - - - `ProgramOutput object { id, call_id, result, 2 more }` - - - `id: string` - - The unique ID of the program output item. - - - `call_id: string` - - The call ID of the program item. - - - `result: string` - - The result produced by the program item. - - - `status: "completed" or "incomplete"` - - The terminal status of the program output item. - - - `"completed"` - - - `"incomplete"` - - - `type: "program_output"` - - The type of the item. Always `program_output`. - - - `"program_output"` - - - `ToolSearchCall object { id, arguments, call_id, 4 more }` - - - `id: string` - - The unique ID of the tool search call item. - - - `arguments: unknown` - - Arguments used for the tool search call. - - - `call_id: string or null` - - The unique ID of the tool search call generated by the model. - - - `execution: "server" or "client"` - - Whether tool search was executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the tool search call item that was recorded. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "tool_search_call"` - - The type of the item. Always `tool_search_call`. - - - `"tool_search_call"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `ToolSearchOutput object { id, call_id, execution, 4 more }` - - - `id: string` - - The unique ID of the tool search output item. - - - `call_id: string or null` - - The unique ID of the tool search call generated by the model. - - - `execution: "server" or "client"` - - Whether tool search was executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the tool search output item that was recorded. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more` - - The loaded tool definitions returned by tool search. - - - `Function object { name, parameters, strict, 5 more }` - - 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). - - - `name: string` - - The name of the function to call. - - - `parameters: map[unknown] or null` - - A JSON schema object describing the parameters of the function. - - - `strict: boolean or null` - - Whether strict parameter validation is enforced for this function tool. - - - `type: "function"` - - The type of the function tool. Always `function`. - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function is deferred and loaded via tool search. - - - `description: optional string or null` - - A description of the function. Used by the model to determine whether or not to call the function. - - - `output_schema: optional map[unknown] or null` - - A JSON schema object describing the JSON value encoded in string outputs for this function. - - - `FileSearch object { type, vector_store_ids, filters, 2 more }` - - 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). - - - `type: "file_search"` - - The type of the file search tool. Always `file_search`. - - - `"file_search"` - - - `vector_store_ids: array of string` - - The IDs of the vector stores to search. - - - `filters: optional ComparisonFilter or CompoundFilter or null` - - A filter to apply. - - - `ComparisonFilter object { key, type, value }` - - A filter used to compare a specified attribute key to a given value using a defined comparison operation. - - - `CompoundFilter object { filters, type }` - - Combine multiple filters using `and` or `or`. - - - `max_num_results: optional number` - - The maximum number of results to return. This number should be between 1 and 50 inclusive. - - - `ranking_options: optional object { hybrid_search, ranker, score_threshold }` - - Ranking options for search. - - - `hybrid_search: optional object { embedding_weight, text_weight }` - - Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. - - - `embedding_weight: number` - - The weight of the embedding in the reciprocal ranking fusion. - - - `text_weight: number` - - The weight of the text in the reciprocal ranking fusion. - - - `ranker: optional "auto" or "default-2024-11-15"` - - The ranker to use for the file search. - - - `"auto"` - - - `"default-2024-11-15"` - - - `score_threshold: optional number` - - The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results. - - - `Computer object { type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `type: "computer"` - - The type of the computer tool. Always `computer`. - - - `"computer"` - - - `ComputerUsePreview object { display_height, display_width, environment, type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `display_height: number` - - The height of the computer display. - - - `display_width: number` - - The width of the computer display. - - - `environment: "windows" or "mac" or "linux" or 2 more` - - The type of computer environment to control. - - - `"windows"` - - - `"mac"` - - - `"linux"` - - - `"ubuntu"` - - - `"browser"` - - - `type: "computer_use_preview"` - - The type of the computer use tool. Always `computer_use_preview`. - - - `"computer_use_preview"` - - - `WebSearch object { type, filters, search_context_size, user_location }` - - Search the Internet for sources related to the prompt. Learn more about the - [web search tool](/docs/guides/tools-web-search). - - - `type: "web_search" or "web_search_2025_08_26"` - - The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - - - `"web_search"` - - - `"web_search_2025_08_26"` - - - `filters: optional object { allowed_domains } or null` - - Filters for the search. - - - `allowed_domains: optional array of string or null` - - Allowed domains for the search. If not provided, all domains are allowed. - Subdomains of the provided domains are allowed as well. - - Example: `["pubmed.ncbi.nlm.nih.gov"]` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { city, country, region, 2 more } or null` - - The approximate location of the user. - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `type: optional "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `Mcp object { server_label, type, allowed_callers, 9 more }` - - Give the model access to additional tools via remote Model Context Protocol - (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp). - - - `server_label: string` - - A label for this MCP server, used to identify it in tool calls. - - - `type: "mcp"` - - The type of the MCP tool. Always `mcp`. - - - `"mcp"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `allowed_tools: optional array of string or object { read_only, tool_names } or null` - - List of allowed tool names or a filter object. - - - `McpAllowedTools = array of string` - - A string array of allowed tool names - - - `McpToolFilter object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `authorization: optional string` - - An OAuth access token that can be used with a remote MCP server, either - with a custom MCP server URL or a service connector. Your application - must handle the OAuth authorization flow and provide the token here. - - - `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more` - - 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](/docs/guides/tools-remote-mcp#connectors). - - Currently supported `connector_id` values are: - - - Dropbox: `connector_dropbox` - - Gmail: `connector_gmail` - - Google Calendar: `connector_googlecalendar` - - Google Drive: `connector_googledrive` - - Microsoft Teams: `connector_microsoftteams` - - Outlook Calendar: `connector_outlookcalendar` - - Outlook Email: `connector_outlookemail` - - SharePoint: `connector_sharepoint` - - - `"connector_dropbox"` - - - `"connector_gmail"` - - - `"connector_googlecalendar"` - - - `"connector_googledrive"` - - - `"connector_microsoftteams"` - - - `"connector_outlookcalendar"` - - - `"connector_outlookemail"` - - - `"connector_sharepoint"` - - - `defer_loading: optional boolean` - - Whether this MCP tool is deferred and discovered via tool search. - - - `headers: optional map[string] or null` - - Optional HTTP headers to send to the MCP server. Use for authentication - or other purposes. - - - `require_approval: optional object { always, never } or "always" or "never" or null` - - Specify which of the MCP server's tools require approval. - - - `McpToolApprovalFilter object { always, never }` - - Specify which of the MCP server's tools require approval. Can be - `always`, `never`, or a filter object associated with tools - that require approval. - - - `always: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `never: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `McpToolApprovalSetting = "always" or "never"` - - Specify a single approval policy for all tools. One of `always` or - `never`. When set to `always`, all tools will require approval. When - set to `never`, all tools will not require approval. - - - `"always"` - - - `"never"` - - - `server_description: optional string` - - Optional description of the MCP server, used to provide more context. - - - `server_url: optional string` - - The URL for the MCP server. One of `server_url`, `connector_id`, or - `tunnel_id` must be provided. - - - `tunnel_id: optional string` - - The Secure MCP Tunnel ID to use instead of a direct server URL. One of - `server_url`, `connector_id`, or `tunnel_id` must be provided. - - - `CodeInterpreter object { container, type, allowed_callers }` - - A tool that runs Python code to help generate a response to a prompt. - - - `container: string or object { type, file_ids, memory_limit, network_policy }` - - The code interpreter container. Can be a container ID or an object that - specifies uploaded file IDs to make available to your code, along with an - optional `memory_limit` setting. - - - `string` - - The container ID. - - - `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }` - - Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. - - - `type: "auto"` - - Always `auto`. - - - `"auto"` - - - `file_ids: optional array of string` - - An optional list of uploaded files to make available to your code. - - - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` - - The memory limit for the code interpreter container. - - - `"1g"` - - - `"4g"` - - - `"16g"` - - - `"64g"` - - - `network_policy: optional ContainerNetworkPolicyDisabled or ContainerNetworkPolicyAllowlist` - - Network access policy for the container. - - - `ContainerNetworkPolicyDisabled object { type }` - - - `ContainerNetworkPolicyAllowlist object { allowed_domains, type, domain_secrets }` - - - `type: "code_interpreter"` - - The type of the code interpreter tool. Always `code_interpreter`. - - - `"code_interpreter"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `ProgrammaticToolCalling object { type }` - - - `type: "programmatic_tool_calling"` - - The type of the tool. Always `programmatic_tool_calling`. - - - `"programmatic_tool_calling"` - - - `ImageGeneration object { type, action, background, 9 more }` - - A tool that generates images using the GPT image models. - - - `type: "image_generation"` - - The type of the image generation tool. Always `image_generation`. - - - `"image_generation"` - - - `action: optional "generate" or "edit" or "auto"` - - Whether to generate a new image or edit an existing image. Default: `auto`. - - - `"generate"` - - - `"edit"` - - - `"auto"` - - - `background: optional "transparent" or "opaque" or "auto"` - - Background type for the generated image. One of `transparent`, - `opaque`, or `auto`. Default: `auto`. - - - `"transparent"` - - - `"opaque"` - - - `"auto"` - - - `input_fidelity: optional "high" or "low" or null` - - 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`. - - - `"high"` - - - `"low"` - - - `input_image_mask: optional object { file_id, image_url }` - - Optional mask for inpainting. Contains `image_url` - (string, optional) and `file_id` (string, optional). - - - `file_id: optional string` - - File ID for the mask image. - - - `image_url: optional string` - - Base64-encoded mask image. - - - `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `string` - - - `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `"gpt-image-1"` - - - `"gpt-image-1-mini"` - - - `"gpt-image-1.5"` - - - `moderation: optional "auto" or "low"` - - Moderation level for the generated image. Default: `auto`. - - - `"auto"` - - - `"low"` - - - `output_compression: optional number` - - Compression level for the output image. Default: 100. - - - `output_format: optional "png" or "webp" or "jpeg"` - - The output format of the generated image. One of `png`, `webp`, or - `jpeg`. Default: `png`. - - - `"png"` - - - `"webp"` - - - `"jpeg"` - - - `partial_images: optional number` - - Number of partial images to generate in streaming mode, from 0 (default value) to 3. - - - `quality: optional "low" or "medium" or "high" or "auto"` - - The quality of the generated image. One of `low`, `medium`, `high`, - or `auto`. Default: `auto`. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `"auto"` - - - `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `string` - - - `"1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `"1024x1024"` - - - `"1024x1536"` - - - `"1536x1024"` - - - `"auto"` - - - `LocalShell object { type }` - - A tool that allows the model to execute shell commands in a local environment. - - - `type: "local_shell"` - - The type of the local shell tool. Always `local_shell`. - - - `"local_shell"` - - - `Shell object { type, allowed_callers, environment }` - - A tool that allows the model to execute shell commands. - - - `type: "shell"` - - The type of the shell tool. Always `shell`. - - - `"shell"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - - - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` - - - `LocalEnvironment object { type, skills }` - - - `ContainerReference object { container_id, type }` - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `Namespace object { description, name, tools, type }` - - Groups function/custom tools under a shared namespace. - - - `description: string` - - A description of the namespace shown to the model. - - - `name: string` - - The namespace name used in tool calls (for example, `crm`). - - - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }` - - The function/custom tools available inside this namespace. - - - `Function object { name, type, allowed_callers, 5 more }` - - - `name: string` - - - `type: "function"` - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function should be deferred and discovered via tool search. - - - `description: optional string or null` - - - `output_schema: optional map[unknown] or null` - - A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs. - - - `parameters: optional unknown or null` - - - `strict: optional boolean or null` - - Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise. - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `type: "namespace"` - - The type of the tool. Always `namespace`. - - - `"namespace"` - - - `ToolSearch object { type, description, execution, parameters }` - - Hosted or BYOT tool search configuration for deferred tools. - - - `type: "tool_search"` - - The type of the tool. Always `tool_search`. - - - `"tool_search"` - - - `description: optional string or null` - - Description shown to the model for a client-executed tool search tool. - - - `execution: optional "server" or "client"` - - Whether tool search is executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `parameters: optional unknown or null` - - Parameter schema for a client-executed tool search tool. - - - `WebSearchPreview object { type, search_content_types, search_context_size, user_location }` - - 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). - - - `type: "web_search_preview" or "web_search_preview_2025_03_11"` - - The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. - - - `"web_search_preview"` - - - `"web_search_preview_2025_03_11"` - - - `search_content_types: optional array of "text" or "image"` - - - `"text"` - - - `"image"` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { type, city, country, 2 more } or null` - - The user's location. - - - `type: "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `ApplyPatch object { type, allowed_callers }` - - Allows the assistant to create, delete, or update files using unified diffs. - - - `type: "apply_patch"` - - The type of the tool. Always `apply_patch`. - - - `"apply_patch"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `type: "tool_search_output"` - - The type of the item. Always `tool_search_output`. - - - `"tool_search_output"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `AdditionalTools object { id, role, tools, type }` - - - `id: string` - - The unique ID of the additional tools item. - - - `role: "unknown" or "user" or "assistant" or 5 more` - - The role that provided the additional tools. - - - `"unknown"` - - - `"user"` - - - `"assistant"` - - - `"system"` - - - `"critic"` - - - `"discriminator"` - - - `"developer"` - - - `"tool"` - - - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more` - - The additional tool definitions made available at this item. - - - `Function object { name, parameters, strict, 5 more }` - - 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). - - - `name: string` - - The name of the function to call. - - - `parameters: map[unknown] or null` - - A JSON schema object describing the parameters of the function. - - - `strict: boolean or null` - - Whether strict parameter validation is enforced for this function tool. - - - `type: "function"` - - The type of the function tool. Always `function`. - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function is deferred and loaded via tool search. - - - `description: optional string or null` - - A description of the function. Used by the model to determine whether or not to call the function. - - - `output_schema: optional map[unknown] or null` - - A JSON schema object describing the JSON value encoded in string outputs for this function. - - - `FileSearch object { type, vector_store_ids, filters, 2 more }` - - 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). - - - `type: "file_search"` - - The type of the file search tool. Always `file_search`. - - - `"file_search"` - - - `vector_store_ids: array of string` - - The IDs of the vector stores to search. - - - `filters: optional ComparisonFilter or CompoundFilter or null` - - A filter to apply. - - - `ComparisonFilter object { key, type, value }` - - A filter used to compare a specified attribute key to a given value using a defined comparison operation. - - - `CompoundFilter object { filters, type }` - - Combine multiple filters using `and` or `or`. - - - `max_num_results: optional number` - - The maximum number of results to return. This number should be between 1 and 50 inclusive. - - - `ranking_options: optional object { hybrid_search, ranker, score_threshold }` - - Ranking options for search. - - - `hybrid_search: optional object { embedding_weight, text_weight }` - - Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. - - - `embedding_weight: number` - - The weight of the embedding in the reciprocal ranking fusion. - - - `text_weight: number` - - The weight of the text in the reciprocal ranking fusion. - - - `ranker: optional "auto" or "default-2024-11-15"` - - The ranker to use for the file search. - - - `"auto"` - - - `"default-2024-11-15"` - - - `score_threshold: optional number` - - The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results. - - - `Computer object { type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `type: "computer"` - - The type of the computer tool. Always `computer`. - - - `"computer"` - - - `ComputerUsePreview object { display_height, display_width, environment, type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `display_height: number` - - The height of the computer display. - - - `display_width: number` - - The width of the computer display. - - - `environment: "windows" or "mac" or "linux" or 2 more` - - The type of computer environment to control. - - - `"windows"` - - - `"mac"` - - - `"linux"` - - - `"ubuntu"` - - - `"browser"` - - - `type: "computer_use_preview"` - - The type of the computer use tool. Always `computer_use_preview`. - - - `"computer_use_preview"` - - - `WebSearch object { type, filters, search_context_size, user_location }` - - Search the Internet for sources related to the prompt. Learn more about the - [web search tool](/docs/guides/tools-web-search). - - - `type: "web_search" or "web_search_2025_08_26"` - - The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - - - `"web_search"` - - - `"web_search_2025_08_26"` - - - `filters: optional object { allowed_domains } or null` - - Filters for the search. - - - `allowed_domains: optional array of string or null` - - Allowed domains for the search. If not provided, all domains are allowed. - Subdomains of the provided domains are allowed as well. - - Example: `["pubmed.ncbi.nlm.nih.gov"]` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { city, country, region, 2 more } or null` - - The approximate location of the user. - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `type: optional "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `Mcp object { server_label, type, allowed_callers, 9 more }` - - Give the model access to additional tools via remote Model Context Protocol - (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp). - - - `server_label: string` - - A label for this MCP server, used to identify it in tool calls. - - - `type: "mcp"` - - The type of the MCP tool. Always `mcp`. - - - `"mcp"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `allowed_tools: optional array of string or object { read_only, tool_names } or null` - - List of allowed tool names or a filter object. - - - `McpAllowedTools = array of string` - - A string array of allowed tool names - - - `McpToolFilter object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `authorization: optional string` - - An OAuth access token that can be used with a remote MCP server, either - with a custom MCP server URL or a service connector. Your application - must handle the OAuth authorization flow and provide the token here. - - - `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more` - - 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](/docs/guides/tools-remote-mcp#connectors). - - Currently supported `connector_id` values are: - - - Dropbox: `connector_dropbox` - - Gmail: `connector_gmail` - - Google Calendar: `connector_googlecalendar` - - Google Drive: `connector_googledrive` - - Microsoft Teams: `connector_microsoftteams` - - Outlook Calendar: `connector_outlookcalendar` - - Outlook Email: `connector_outlookemail` - - SharePoint: `connector_sharepoint` - - - `"connector_dropbox"` - - - `"connector_gmail"` - - - `"connector_googlecalendar"` - - - `"connector_googledrive"` - - - `"connector_microsoftteams"` - - - `"connector_outlookcalendar"` - - - `"connector_outlookemail"` - - - `"connector_sharepoint"` - - - `defer_loading: optional boolean` - - Whether this MCP tool is deferred and discovered via tool search. - - - `headers: optional map[string] or null` - - Optional HTTP headers to send to the MCP server. Use for authentication - or other purposes. - - - `require_approval: optional object { always, never } or "always" or "never" or null` - - Specify which of the MCP server's tools require approval. - - - `McpToolApprovalFilter object { always, never }` - - Specify which of the MCP server's tools require approval. Can be - `always`, `never`, or a filter object associated with tools - that require approval. - - - `always: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `never: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `McpToolApprovalSetting = "always" or "never"` - - Specify a single approval policy for all tools. One of `always` or - `never`. When set to `always`, all tools will require approval. When - set to `never`, all tools will not require approval. - - - `"always"` - - - `"never"` - - - `server_description: optional string` - - Optional description of the MCP server, used to provide more context. - - - `server_url: optional string` - - The URL for the MCP server. One of `server_url`, `connector_id`, or - `tunnel_id` must be provided. - - - `tunnel_id: optional string` - - The Secure MCP Tunnel ID to use instead of a direct server URL. One of - `server_url`, `connector_id`, or `tunnel_id` must be provided. - - - `CodeInterpreter object { container, type, allowed_callers }` - - A tool that runs Python code to help generate a response to a prompt. - - - `container: string or object { type, file_ids, memory_limit, network_policy }` - - The code interpreter container. Can be a container ID or an object that - specifies uploaded file IDs to make available to your code, along with an - optional `memory_limit` setting. - - - `string` - - The container ID. - - - `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }` - - Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. - - - `type: "auto"` - - Always `auto`. - - - `"auto"` - - - `file_ids: optional array of string` - - An optional list of uploaded files to make available to your code. - - - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` - - The memory limit for the code interpreter container. - - - `"1g"` - - - `"4g"` - - - `"16g"` - - - `"64g"` - - - `network_policy: optional ContainerNetworkPolicyDisabled or ContainerNetworkPolicyAllowlist` - - Network access policy for the container. - - - `ContainerNetworkPolicyDisabled object { type }` - - - `ContainerNetworkPolicyAllowlist object { allowed_domains, type, domain_secrets }` - - - `type: "code_interpreter"` - - The type of the code interpreter tool. Always `code_interpreter`. - - - `"code_interpreter"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `ProgrammaticToolCalling object { type }` - - - `type: "programmatic_tool_calling"` - - The type of the tool. Always `programmatic_tool_calling`. - - - `"programmatic_tool_calling"` - - - `ImageGeneration object { type, action, background, 9 more }` - - A tool that generates images using the GPT image models. - - - `type: "image_generation"` - - The type of the image generation tool. Always `image_generation`. - - - `"image_generation"` - - - `action: optional "generate" or "edit" or "auto"` - - Whether to generate a new image or edit an existing image. Default: `auto`. - - - `"generate"` - - - `"edit"` - - - `"auto"` - - - `background: optional "transparent" or "opaque" or "auto"` - - Background type for the generated image. One of `transparent`, - `opaque`, or `auto`. Default: `auto`. - - - `"transparent"` - - - `"opaque"` - - - `"auto"` - - - `input_fidelity: optional "high" or "low" or null` - - 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`. - - - `"high"` - - - `"low"` - - - `input_image_mask: optional object { file_id, image_url }` - - Optional mask for inpainting. Contains `image_url` - (string, optional) and `file_id` (string, optional). - - - `file_id: optional string` - - File ID for the mask image. - - - `image_url: optional string` - - Base64-encoded mask image. - - - `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `string` - - - `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `"gpt-image-1"` - - - `"gpt-image-1-mini"` - - - `"gpt-image-1.5"` - - - `moderation: optional "auto" or "low"` - - Moderation level for the generated image. Default: `auto`. - - - `"auto"` - - - `"low"` - - - `output_compression: optional number` - - Compression level for the output image. Default: 100. - - - `output_format: optional "png" or "webp" or "jpeg"` - - The output format of the generated image. One of `png`, `webp`, or - `jpeg`. Default: `png`. - - - `"png"` - - - `"webp"` - - - `"jpeg"` - - - `partial_images: optional number` - - Number of partial images to generate in streaming mode, from 0 (default value) to 3. - - - `quality: optional "low" or "medium" or "high" or "auto"` - - The quality of the generated image. One of `low`, `medium`, `high`, - or `auto`. Default: `auto`. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `"auto"` - - - `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `string` - - - `"1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `"1024x1024"` - - - `"1024x1536"` - - - `"1536x1024"` - - - `"auto"` - - - `LocalShell object { type }` - - A tool that allows the model to execute shell commands in a local environment. - - - `type: "local_shell"` - - The type of the local shell tool. Always `local_shell`. - - - `"local_shell"` - - - `Shell object { type, allowed_callers, environment }` - - A tool that allows the model to execute shell commands. - - - `type: "shell"` - - The type of the shell tool. Always `shell`. - - - `"shell"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - - - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` - - - `LocalEnvironment object { type, skills }` - - - `ContainerReference object { container_id, type }` - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `Namespace object { description, name, tools, type }` - - Groups function/custom tools under a shared namespace. - - - `description: string` - - A description of the namespace shown to the model. - - - `name: string` - - The namespace name used in tool calls (for example, `crm`). - - - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }` - - The function/custom tools available inside this namespace. - - - `Function object { name, type, allowed_callers, 5 more }` - - - `name: string` - - - `type: "function"` - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function should be deferred and discovered via tool search. - - - `description: optional string or null` - - - `output_schema: optional map[unknown] or null` - - A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs. - - - `parameters: optional unknown or null` - - - `strict: optional boolean or null` - - Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise. - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `type: "namespace"` - - The type of the tool. Always `namespace`. - - - `"namespace"` - - - `ToolSearch object { type, description, execution, parameters }` - - Hosted or BYOT tool search configuration for deferred tools. - - - `type: "tool_search"` - - The type of the tool. Always `tool_search`. - - - `"tool_search"` - - - `description: optional string or null` - - Description shown to the model for a client-executed tool search tool. - - - `execution: optional "server" or "client"` - - Whether tool search is executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `parameters: optional unknown or null` - - Parameter schema for a client-executed tool search tool. - - - `WebSearchPreview object { type, search_content_types, search_context_size, user_location }` - - 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). - - - `type: "web_search_preview" or "web_search_preview_2025_03_11"` - - The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. - - - `"web_search_preview"` - - - `"web_search_preview_2025_03_11"` - - - `search_content_types: optional array of "text" or "image"` - - - `"text"` - - - `"image"` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { type, city, country, 2 more } or null` - - The user's location. - - - `type: "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `ApplyPatch object { type, allowed_callers }` - - Allows the assistant to create, delete, or update files using unified diffs. - - - `type: "apply_patch"` - - The type of the tool. Always `apply_patch`. - - - `"apply_patch"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `type: "additional_tools"` - - The type of the item. Always `additional_tools`. - - - `"additional_tools"` - - - `Compaction object { id, encrypted_content, type, created_by }` - - A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). - - - `id: string` - - The unique ID of the compaction item. - - - `encrypted_content: string` - - The encrypted content that was produced by compaction. - - - `type: "compaction"` - - The type of the item. Always `compaction`. - - - `"compaction"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `ImageGenerationCall object { id, result, status, type }` - - An image generation request made by the model. - - - `id: string` - - The unique ID of the image generation call. - - - `result: string or null` - - The generated image encoded in base64. - - - `status: "in_progress" or "completed" or "generating" or "failed"` - - The status of the image generation call. - - - `"in_progress"` - - - `"completed"` - - - `"generating"` - - - `"failed"` - - - `type: "image_generation_call"` - - The type of the image generation call. Always `image_generation_call`. - - - `"image_generation_call"` - - - `CodeInterpreterCall object { id, code, container_id, 3 more }` - - A tool call to run code. - - - `id: string` - - The unique ID of the code interpreter tool call. - - - `code: string or null` - - The code to run, or null if not available. - - - `container_id: string` - - The ID of the container used to run the code. - - - `outputs: array of object { logs, type } or object { type, url } or null` - - The outputs generated by the code interpreter, such as logs or images. - Can be null if no outputs are available. - - - `Logs object { logs, type }` - - The logs output from the code interpreter. - - - `logs: string` - - The logs output from the code interpreter. - - - `type: "logs"` - - The type of the output. Always `logs`. - - - `"logs"` - - - `Image object { type, url }` - - The image output from the code interpreter. - - - `type: "image"` - - The type of the output. Always `image`. - - - `"image"` - - - `url: string` - - The URL of the image output from the code interpreter. - - - `status: "in_progress" or "completed" or "incomplete" or 2 more` - - The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `"interpreting"` - - - `"failed"` - - - `type: "code_interpreter_call"` - - The type of the code interpreter tool call. Always `code_interpreter_call`. - - - `"code_interpreter_call"` - - - `LocalShellCall object { id, action, call_id, 2 more }` - - A tool call to run a command on the local shell. - - - `id: string` - - The unique ID of the local shell call. - - - `action: object { command, env, type, 3 more }` - - Execute a shell command on the server. - - - `command: array of string` - - The command to run. - - - `env: map[string]` - - Environment variables to set for the command. - - - `type: "exec"` - - The type of the local shell action. Always `exec`. - - - `"exec"` - - - `timeout_ms: optional number or null` - - Optional timeout in milliseconds for the command. - - - `user: optional string or null` - - Optional user to run the command as. - - - `working_directory: optional string or null` - - Optional working directory to run the command in. - - - `call_id: string` - - The unique ID of the local shell tool call generated by the model. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the local shell call. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "local_shell_call"` - - The type of the local shell call. Always `local_shell_call`. - - - `"local_shell_call"` - - - `LocalShellCallOutput object { id, output, type, status }` - - The output of a local shell tool call. - - - `id: string` - - The unique ID of the local shell tool call generated by the model. - - - `output: string` - - A JSON string of the output of the local shell tool call. - - - `type: "local_shell_call_output"` - - The type of the local shell tool call output. Always `local_shell_call_output`. - - - `"local_shell_call_output"` - - - `status: optional "in_progress" or "completed" or "incomplete" or null` - - The status of the item. One of `in_progress`, `completed`, or `incomplete`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `ShellCall object { id, action, call_id, 5 more }` - - A tool call that executes one or more shell commands in a managed environment. - - - `id: string` - - The unique ID of the shell tool call. Populated when this item is returned via API. - - - `action: object { commands, max_output_length, timeout_ms }` - - The shell commands and limits that describe how to run the tool call. - - - `commands: array of string` - - - `max_output_length: number or null` - - Optional maximum number of characters to return from each command. - - - `timeout_ms: number or null` - - Optional timeout in milliseconds for the commands. - - - `call_id: string` - - The unique ID of the shell tool call generated by the model. - - - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` - - Represents the use of a local environment to perform shell actions. - - - `ResponseLocalEnvironment object { type }` - - Represents the use of a local environment to perform shell actions. - - - `type: "local"` - - The environment type. Always `local`. - - - `"local"` - - - `ResponseContainerReference object { container_id, type }` - - Represents a container created with /v1/containers. - - - `container_id: string` - - - `type: "container_reference"` - - The environment type. Always `container_reference`. - - - `"container_reference"` - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "shell_call"` - - The type of the item. Always `shell_call`. - - - `"shell_call"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The ID of the entity that created this tool call. - - - `ShellCallOutput object { id, call_id, max_output_length, 5 more }` - - The output of a shell tool call that was emitted. - - - `id: string` - - The unique ID of the shell call output. Populated when this item is returned via API. - - - `call_id: string` - - The unique ID of the shell tool call generated by the model. - - - `max_output_length: number or null` - - The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. - - - `output: array of object { outcome, stderr, stdout, created_by }` - - An array of shell call output contents - - - `outcome: object { type } or object { exit_code, type }` - - Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. - - - `Timeout object { type }` - - Indicates that the shell call exceeded its configured time limit. - - - `type: "timeout"` - - The outcome type. Always `timeout`. - - - `"timeout"` - - - `Exit object { exit_code, type }` - - Indicates that the shell commands finished and returned an exit code. - - - `exit_code: number` - - Exit code from the shell process. - - - `type: "exit"` - - The outcome type. Always `exit`. - - - `"exit"` - - - `stderr: string` - - The standard error output that was captured. - - - `stdout: string` - - The standard output that was captured. - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "shell_call_output"` - - The type of the shell call output. Always `shell_call_output`. - - - `"shell_call_output"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `ApplyPatchCall object { id, call_id, operation, 4 more }` - - A tool call that applies file diffs by creating, deleting, or updating files. - - - `id: string` - - The unique ID of the apply patch tool call. Populated when this item is returned via API. - - - `call_id: string` - - The unique ID of the apply patch tool call generated by the model. - - - `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }` - - One of the create_file, delete_file, or update_file operations applied via apply_patch. - - - `CreateFile object { diff, path, type }` - - Instruction describing how to create a file via the apply_patch tool. - - - `diff: string` - - Diff to apply. - - - `path: string` - - Path of the file to create. - - - `type: "create_file"` - - Create a new file with the provided diff. - - - `"create_file"` - - - `DeleteFile object { path, type }` - - Instruction describing how to delete a file via the apply_patch tool. - - - `path: string` - - Path of the file to delete. - - - `type: "delete_file"` - - Delete the specified file. - - - `"delete_file"` - - - `UpdateFile object { diff, path, type }` - - Instruction describing how to update a file via the apply_patch tool. - - - `diff: string` - - Diff to apply. - - - `path: string` - - Path of the file to update. - - - `type: "update_file"` - - Update an existing file with the provided diff. - - - `"update_file"` - - - `status: "in_progress" or "completed"` - - The status of the apply patch tool call. One of `in_progress` or `completed`. - - - `"in_progress"` - - - `"completed"` - - - `type: "apply_patch_call"` - - The type of the item. Always `apply_patch_call`. - - - `"apply_patch_call"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The ID of the entity that created this tool call. - - - `ApplyPatchCallOutput object { id, call_id, status, 4 more }` - - The output emitted by an apply patch tool call. - - - `id: string` - - The unique ID of the apply patch tool call output. Populated when this item is returned via API. - - - `call_id: string` - - The unique ID of the apply patch tool call generated by the model. - - - `status: "completed" or "failed"` - - The status of the apply patch tool call output. One of `completed` or `failed`. - - - `"completed"` - - - `"failed"` - - - `type: "apply_patch_call_output"` - - The type of the item. Always `apply_patch_call_output`. - - - `"apply_patch_call_output"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The ID of the entity that created this tool call output. - - - `output: optional string or null` - - Optional textual output returned by the apply patch tool. - - - `McpCall object { id, arguments, name, 6 more }` - - An invocation of a tool on an MCP server. - - - `id: string` - - The unique ID of the tool call. - - - `arguments: string` - - A JSON string of the arguments passed to the tool. - - - `name: string` - - The name of the tool that was run. - - - `server_label: string` - - The label of the MCP server running the tool. - - - `type: "mcp_call"` - - The type of the item. Always `mcp_call`. - - - `"mcp_call"` - - - `approval_request_id: optional string or null` - - Unique identifier for the MCP tool call approval request. - Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. - - - `error: optional string or null` - - The error from the tool call, if any. - - - `output: optional string or null` - - The output from the tool call. - - - `status: optional "in_progress" or "completed" or "incomplete" or 2 more` - - The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `"calling"` - - - `"failed"` - - - `McpListTools object { id, server_label, tools, 2 more }` - - A list of tools available on an MCP server. - - - `id: string` - - The unique ID of the list. - - - `server_label: string` - - The label of the MCP server. - - - `tools: array of object { input_schema, name, annotations, description }` - - The tools available on the server. - - - `input_schema: unknown` - - The JSON schema describing the tool's input. - - - `name: string` - - The name of the tool. - - - `annotations: optional unknown or null` - - Additional annotations about the tool. - - - `description: optional string or null` - - The description of the tool. - - - `type: "mcp_list_tools"` - - The type of the item. Always `mcp_list_tools`. - - - `"mcp_list_tools"` - - - `error: optional string or null` - - Error message if the server could not list tools. - - - `McpApprovalRequest object { id, arguments, name, 2 more }` - - A request for human approval of a tool invocation. - - - `id: string` - - The unique ID of the approval request. - - - `arguments: string` - - A JSON string of arguments for the tool. - - - `name: string` - - The name of the tool to run. - - - `server_label: string` - - The label of the MCP server making the request. - - - `type: "mcp_approval_request"` - - The type of the item. Always `mcp_approval_request`. - - - `"mcp_approval_request"` - - - `McpApprovalResponse object { id, approval_request_id, approve, 2 more }` - - A response to an MCP approval request. - - - `id: string` - - The unique ID of the approval response - - - `approval_request_id: string` - - The ID of the approval request being answered. - - - `approve: boolean` - - Whether the request was approved. - - - `type: "mcp_approval_response"` - - The type of the item. Always `mcp_approval_response`. - - - `"mcp_approval_response"` - - - `reason: optional string or null` - - Optional reason for the decision. - - - `CustomToolCall object { call_id, input, name, 4 more }` - - A call to a custom tool created by the model. - - - `call_id: string` - - An identifier used to map this custom tool call to a tool call output. - - - `input: string` - - The input for the custom tool call generated by the model. - - - `name: string` - - The name of the custom tool being called. - - - `type: "custom_tool_call"` - - The type of the custom tool call. Always `custom_tool_call`. - - - `"custom_tool_call"` - - - `id: optional string` - - The unique ID of the custom tool call in the OpenAI platform. - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `namespace: optional string` - - The namespace of the custom tool being called. - - - `CustomToolCallOutput object { id, call_id, output, 4 more }` - - - `id: string` - - The unique ID of the custom tool call output item. - - - `call_id: string` - - The call ID, used to map this custom tool call output to a custom tool call. - - - `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - The output from the custom tool call generated by your code. - Can be a string or an list of output content. - - - `StringOutput = string` - - A string of the output of the custom tool call. - - - `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - Text, image, or file output of the custom tool call. - - - `ResponseInputText object { text, type, prompt_cache_breakpoint }` - - A text input to the model. - - - `ResponseInputImage object { detail, type, file_id, 2 more }` - - An image input to the model. Learn about [image inputs](/docs/guides/vision). - - - `ResponseInputFile object { type, detail, file_data, 4 more }` - - A file input to the model. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "custom_tool_call_output"` - - The type of the custom tool call output. Always `custom_tool_call_output`. - - - `"custom_tool_call_output"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - The caller type. Always `direct`. - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - The caller type. Always `program`. - - - `"program"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `parallel_tool_calls: boolean` - - Whether to allow the model to run tool calls in parallel. - - - `temperature: number or null` - - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. - We generally recommend altering this or `top_p` but not both. - - - `tool_choice: ToolChoiceOptions or ToolChoiceAllowed or ToolChoiceTypes or 6 more` - - How the model should select which tool (or tools) to use when generating - a response. See the `tools` parameter to see how to specify which tools - the model can call. - - - `ToolChoiceOptions = "none" or "auto" or "required"` - - Controls which (if any) tool is called by the model. - - `none` means the model will not call any tool and instead generates a message. - - `auto` means the model can pick between generating a message or calling one or - more tools. - - `required` means the model must call one or more tools. - - - `"none"` - - - `"auto"` - - - `"required"` - - - `ToolChoiceAllowed object { mode, tools, type }` - - Constrains the tools available to the model to a pre-defined set. - - - `mode: "auto" or "required"` - - Constrains the tools available to the model to a pre-defined set. - - `auto` allows the model to pick from among the allowed tools and generate a - message. - - `required` requires the model to call one or more of the allowed tools. - - - `"auto"` - - - `"required"` - - - `tools: array of map[unknown]` - - A list of tool definitions that the model should be allowed to call. - - For the Responses API, the list of tool definitions might look like: - - ```json - [ - { "type": "function", "name": "get_weather" }, - { "type": "mcp", "server_label": "deepwiki" }, - { "type": "image_generation" } - ] - ``` - - - `type: "allowed_tools"` - - Allowed tool configuration type. Always `allowed_tools`. - - - `"allowed_tools"` - - - `ToolChoiceTypes object { type }` - - Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](/docs/guides/tools). - - - `type: "file_search" or "web_search_preview" or "computer" or 5 more` - - The type of hosted tool the model should to use. Learn more about - [built-in tools](/docs/guides/tools). - - Allowed values are: - - - `file_search` - - `web_search_preview` - - `computer` - - `computer_use_preview` - - `computer_use` - - `code_interpreter` - - `image_generation` - - - `"file_search"` - - - `"web_search_preview"` - - - `"computer"` - - - `"computer_use_preview"` - - - `"computer_use"` - - - `"web_search_preview_2025_03_11"` - - - `"image_generation"` - - - `"code_interpreter"` - - - `ToolChoiceFunction object { name, type }` - - Use this option to force the model to call a specific function. - - - `name: string` - - The name of the function to call. - - - `type: "function"` - - For function calling, the type is always `function`. - - - `"function"` - - - `ToolChoiceMcp object { server_label, type, name }` - - Use this option to force the model to call a specific tool on a remote MCP server. - - - `server_label: string` - - The label of the MCP server to use. - - - `type: "mcp"` - - For MCP tools, the type is always `mcp`. - - - `"mcp"` - - - `name: optional string or null` - - The name of the tool to call on the server. - - - `ToolChoiceCustom object { name, type }` - - Use this option to force the model to call a specific custom tool. - - - `name: string` - - The name of the custom tool to call. - - - `type: "custom"` - - For custom tool calling, the type is always `custom`. - - - `"custom"` - - - `SpecificProgrammaticToolCallingParam object { type }` - - - `type: "programmatic_tool_calling"` - - The tool to call. Always `programmatic_tool_calling`. - - - `"programmatic_tool_calling"` - - - `ToolChoiceApplyPatch object { type }` - - Forces the model to call the apply_patch tool when executing a tool call. - - - `type: "apply_patch"` - - The tool to call. Always `apply_patch`. - - - `"apply_patch"` - - - `ToolChoiceShell object { type }` - - Forces the model to call the shell tool when a tool call is required. - - - `type: "shell"` - - The tool to call. Always `shell`. - - - `"shell"` - - - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more` - - An array of tools the model may call while generating a response. You - can specify which tool to use by setting the `tool_choice` parameter. - - 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](/docs/guides/tools-web-search) - or [file search](/docs/guides/tools-file-search). Learn more about - [built-in tools](/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](/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](/docs/guides/function-calling). You can also use - custom tools to call your own code. - - - `Function object { name, parameters, strict, 5 more }` - - 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). - - - `name: string` - - The name of the function to call. - - - `parameters: map[unknown] or null` - - A JSON schema object describing the parameters of the function. - - - `strict: boolean or null` - - Whether strict parameter validation is enforced for this function tool. - - - `type: "function"` - - The type of the function tool. Always `function`. - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function is deferred and loaded via tool search. - - - `description: optional string or null` - - A description of the function. Used by the model to determine whether or not to call the function. - - - `output_schema: optional map[unknown] or null` - - A JSON schema object describing the JSON value encoded in string outputs for this function. - - - `FileSearch object { type, vector_store_ids, filters, 2 more }` - - 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). - - - `type: "file_search"` - - The type of the file search tool. Always `file_search`. - - - `"file_search"` - - - `vector_store_ids: array of string` - - The IDs of the vector stores to search. - - - `filters: optional ComparisonFilter or CompoundFilter or null` - - A filter to apply. - - - `ComparisonFilter object { key, type, value }` - - A filter used to compare a specified attribute key to a given value using a defined comparison operation. - - - `CompoundFilter object { filters, type }` - - Combine multiple filters using `and` or `or`. - - - `max_num_results: optional number` - - The maximum number of results to return. This number should be between 1 and 50 inclusive. - - - `ranking_options: optional object { hybrid_search, ranker, score_threshold }` - - Ranking options for search. - - - `hybrid_search: optional object { embedding_weight, text_weight }` - - Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. - - - `embedding_weight: number` - - The weight of the embedding in the reciprocal ranking fusion. - - - `text_weight: number` - - The weight of the text in the reciprocal ranking fusion. - - - `ranker: optional "auto" or "default-2024-11-15"` - - The ranker to use for the file search. - - - `"auto"` - - - `"default-2024-11-15"` - - - `score_threshold: optional number` - - The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results. - - - `Computer object { type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `type: "computer"` - - The type of the computer tool. Always `computer`. - - - `"computer"` - - - `ComputerUsePreview object { display_height, display_width, environment, type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `display_height: number` - - The height of the computer display. - - - `display_width: number` - - The width of the computer display. - - - `environment: "windows" or "mac" or "linux" or 2 more` - - The type of computer environment to control. - - - `"windows"` - - - `"mac"` - - - `"linux"` - - - `"ubuntu"` - - - `"browser"` - - - `type: "computer_use_preview"` - - The type of the computer use tool. Always `computer_use_preview`. - - - `"computer_use_preview"` - - - `WebSearch object { type, filters, search_context_size, user_location }` - - Search the Internet for sources related to the prompt. Learn more about the - [web search tool](/docs/guides/tools-web-search). - - - `type: "web_search" or "web_search_2025_08_26"` - - The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - - - `"web_search"` - - - `"web_search_2025_08_26"` - - - `filters: optional object { allowed_domains } or null` - - Filters for the search. - - - `allowed_domains: optional array of string or null` - - Allowed domains for the search. If not provided, all domains are allowed. - Subdomains of the provided domains are allowed as well. - - Example: `["pubmed.ncbi.nlm.nih.gov"]` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { city, country, region, 2 more } or null` - - The approximate location of the user. - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `type: optional "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `Mcp object { server_label, type, allowed_callers, 9 more }` - - Give the model access to additional tools via remote Model Context Protocol - (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp). - - - `server_label: string` - - A label for this MCP server, used to identify it in tool calls. - - - `type: "mcp"` - - The type of the MCP tool. Always `mcp`. - - - `"mcp"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `allowed_tools: optional array of string or object { read_only, tool_names } or null` - - List of allowed tool names or a filter object. - - - `McpAllowedTools = array of string` - - A string array of allowed tool names - - - `McpToolFilter object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `authorization: optional string` - - An OAuth access token that can be used with a remote MCP server, either - with a custom MCP server URL or a service connector. Your application - must handle the OAuth authorization flow and provide the token here. - - - `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more` - - 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](/docs/guides/tools-remote-mcp#connectors). - - Currently supported `connector_id` values are: - - - Dropbox: `connector_dropbox` - - Gmail: `connector_gmail` - - Google Calendar: `connector_googlecalendar` - - Google Drive: `connector_googledrive` - - Microsoft Teams: `connector_microsoftteams` - - Outlook Calendar: `connector_outlookcalendar` - - Outlook Email: `connector_outlookemail` - - SharePoint: `connector_sharepoint` - - - `"connector_dropbox"` - - - `"connector_gmail"` - - - `"connector_googlecalendar"` - - - `"connector_googledrive"` - - - `"connector_microsoftteams"` - - - `"connector_outlookcalendar"` - - - `"connector_outlookemail"` - - - `"connector_sharepoint"` - - - `defer_loading: optional boolean` - - Whether this MCP tool is deferred and discovered via tool search. - - - `headers: optional map[string] or null` - - Optional HTTP headers to send to the MCP server. Use for authentication - or other purposes. - - - `require_approval: optional object { always, never } or "always" or "never" or null` - - Specify which of the MCP server's tools require approval. - - - `McpToolApprovalFilter object { always, never }` - - Specify which of the MCP server's tools require approval. Can be - `always`, `never`, or a filter object associated with tools - that require approval. - - - `always: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `never: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `McpToolApprovalSetting = "always" or "never"` - - Specify a single approval policy for all tools. One of `always` or - `never`. When set to `always`, all tools will require approval. When - set to `never`, all tools will not require approval. - - - `"always"` - - - `"never"` - - - `server_description: optional string` - - Optional description of the MCP server, used to provide more context. - - - `server_url: optional string` - - The URL for the MCP server. One of `server_url`, `connector_id`, or - `tunnel_id` must be provided. - - - `tunnel_id: optional string` - - The Secure MCP Tunnel ID to use instead of a direct server URL. One of - `server_url`, `connector_id`, or `tunnel_id` must be provided. - - - `CodeInterpreter object { container, type, allowed_callers }` - - A tool that runs Python code to help generate a response to a prompt. - - - `container: string or object { type, file_ids, memory_limit, network_policy }` - - The code interpreter container. Can be a container ID or an object that - specifies uploaded file IDs to make available to your code, along with an - optional `memory_limit` setting. - - - `string` - - The container ID. - - - `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }` - - Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. - - - `type: "auto"` - - Always `auto`. - - - `"auto"` - - - `file_ids: optional array of string` - - An optional list of uploaded files to make available to your code. - - - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` - - The memory limit for the code interpreter container. - - - `"1g"` - - - `"4g"` - - - `"16g"` - - - `"64g"` - - - `network_policy: optional ContainerNetworkPolicyDisabled or ContainerNetworkPolicyAllowlist` - - Network access policy for the container. - - - `ContainerNetworkPolicyDisabled object { type }` - - - `ContainerNetworkPolicyAllowlist object { allowed_domains, type, domain_secrets }` - - - `type: "code_interpreter"` - - The type of the code interpreter tool. Always `code_interpreter`. - - - `"code_interpreter"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `ProgrammaticToolCalling object { type }` - - - `type: "programmatic_tool_calling"` - - The type of the tool. Always `programmatic_tool_calling`. - - - `"programmatic_tool_calling"` - - - `ImageGeneration object { type, action, background, 9 more }` - - A tool that generates images using the GPT image models. - - - `type: "image_generation"` - - The type of the image generation tool. Always `image_generation`. - - - `"image_generation"` - - - `action: optional "generate" or "edit" or "auto"` - - Whether to generate a new image or edit an existing image. Default: `auto`. - - - `"generate"` - - - `"edit"` - - - `"auto"` - - - `background: optional "transparent" or "opaque" or "auto"` - - Background type for the generated image. One of `transparent`, - `opaque`, or `auto`. Default: `auto`. - - - `"transparent"` - - - `"opaque"` - - - `"auto"` - - - `input_fidelity: optional "high" or "low" or null` - - 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`. - - - `"high"` - - - `"low"` - - - `input_image_mask: optional object { file_id, image_url }` - - Optional mask for inpainting. Contains `image_url` - (string, optional) and `file_id` (string, optional). - - - `file_id: optional string` - - File ID for the mask image. - - - `image_url: optional string` - - Base64-encoded mask image. - - - `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `string` - - - `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `"gpt-image-1"` - - - `"gpt-image-1-mini"` - - - `"gpt-image-1.5"` - - - `moderation: optional "auto" or "low"` - - Moderation level for the generated image. Default: `auto`. - - - `"auto"` - - - `"low"` - - - `output_compression: optional number` - - Compression level for the output image. Default: 100. - - - `output_format: optional "png" or "webp" or "jpeg"` - - The output format of the generated image. One of `png`, `webp`, or - `jpeg`. Default: `png`. - - - `"png"` - - - `"webp"` - - - `"jpeg"` - - - `partial_images: optional number` - - Number of partial images to generate in streaming mode, from 0 (default value) to 3. - - - `quality: optional "low" or "medium" or "high" or "auto"` - - The quality of the generated image. One of `low`, `medium`, `high`, - or `auto`. Default: `auto`. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `"auto"` - - - `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `string` - - - `"1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `"1024x1024"` - - - `"1024x1536"` - - - `"1536x1024"` - - - `"auto"` - - - `LocalShell object { type }` - - A tool that allows the model to execute shell commands in a local environment. - - - `type: "local_shell"` - - The type of the local shell tool. Always `local_shell`. - - - `"local_shell"` - - - `Shell object { type, allowed_callers, environment }` - - A tool that allows the model to execute shell commands. - - - `type: "shell"` - - The type of the shell tool. Always `shell`. - - - `"shell"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - - - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` - - - `LocalEnvironment object { type, skills }` - - - `ContainerReference object { container_id, type }` - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `Namespace object { description, name, tools, type }` - - Groups function/custom tools under a shared namespace. - - - `description: string` - - A description of the namespace shown to the model. - - - `name: string` - - The namespace name used in tool calls (for example, `crm`). - - - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }` - - The function/custom tools available inside this namespace. - - - `Function object { name, type, allowed_callers, 5 more }` - - - `name: string` - - - `type: "function"` - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function should be deferred and discovered via tool search. - - - `description: optional string or null` - - - `output_schema: optional map[unknown] or null` - - A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs. - - - `parameters: optional unknown or null` - - - `strict: optional boolean or null` - - Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise. - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `type: "namespace"` - - The type of the tool. Always `namespace`. - - - `"namespace"` - - - `ToolSearch object { type, description, execution, parameters }` - - Hosted or BYOT tool search configuration for deferred tools. - - - `type: "tool_search"` - - The type of the tool. Always `tool_search`. - - - `"tool_search"` - - - `description: optional string or null` - - Description shown to the model for a client-executed tool search tool. - - - `execution: optional "server" or "client"` - - Whether tool search is executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `parameters: optional unknown or null` - - Parameter schema for a client-executed tool search tool. - - - `WebSearchPreview object { type, search_content_types, search_context_size, user_location }` - - 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). - - - `type: "web_search_preview" or "web_search_preview_2025_03_11"` - - The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. - - - `"web_search_preview"` - - - `"web_search_preview_2025_03_11"` - - - `search_content_types: optional array of "text" or "image"` - - - `"text"` - - - `"image"` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { type, city, country, 2 more } or null` - - The user's location. - - - `type: "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `ApplyPatch object { type, allowed_callers }` - - Allows the assistant to create, delete, or update files using unified diffs. - - - `type: "apply_patch"` - - The type of the tool. Always `apply_patch`. - - - `"apply_patch"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `top_p: number or null` - - An alternative to sampling with temperature, called nucleus sampling, - where the model considers the results of the tokens with top_p probability - mass. So 0.1 means only the tokens comprising the top 10% probability mass - are considered. - - We generally recommend altering this or `temperature` but not both. - - - `background: optional boolean or null` - - Whether to run the model response in the background. - [Learn more](/docs/guides/background). - - - `completed_at: optional number or null` - - Unix timestamp (in seconds) of when this Response was completed. - Only present when the status is `completed`. - - - `conversation: optional object { id } or null` - - The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation. - - - `id: string` - - The unique ID of the conversation that this response was associated with. - - - `max_output_tokens: optional number or null` - - An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning). - - - `max_tool_calls: optional number or null` - - The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored. - - - `moderation: optional object { input, output } or null` - - Moderation results for the response input and output, if moderated completions were requested. - - - `input: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }` - - Moderation for the response input. - - - `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }` - - A moderation result produced for the response input or output. - - - `categories: map[boolean]` - - A dictionary of moderation categories to booleans, True if the input is flagged under this category. - - - `category_applied_input_types: map[array of "text" or "image"]` - - Which modalities of input are reflected by the score for each category. - - - `"text"` - - - `"image"` - - - `category_scores: map[number]` - - A dictionary of moderation categories to scores. - - - `flagged: boolean` - - A boolean indicating whether the content was flagged by any category. - - - `model: string` - - The moderation model that produced this result. - - - `type: "moderation_result"` - - The object type, which was always `moderation_result` for successful moderation results. - - - `"moderation_result"` - - - `Error object { code, message, type }` - - An error produced while attempting moderation for the response input or output. - - - `code: string` - - The error code. - - - `message: string` - - The error message. - - - `type: "error"` - - The object type, which was always `error` for moderation failures. - - - `"error"` - - - `output: object { categories, category_applied_input_types, category_scores, 3 more } or object { code, message, type }` - - Moderation for the response output. - - - `ModerationResult object { categories, category_applied_input_types, category_scores, 3 more }` - - A moderation result produced for the response input or output. - - - `categories: map[boolean]` - - A dictionary of moderation categories to booleans, True if the input is flagged under this category. - - - `category_applied_input_types: map[array of "text" or "image"]` - - Which modalities of input are reflected by the score for each category. - - - `"text"` - - - `"image"` - - - `category_scores: map[number]` - - A dictionary of moderation categories to scores. - - - `flagged: boolean` - - A boolean indicating whether the content was flagged by any category. - - - `model: string` - - The moderation model that produced this result. - - - `type: "moderation_result"` - - The object type, which was always `moderation_result` for successful moderation results. - - - `"moderation_result"` - - - `Error object { code, message, type }` - - An error produced while attempting moderation for the response input or output. - - - `code: string` - - The error code. - - - `message: string` - - The error message. - - - `type: "error"` - - The object type, which was always `error` for moderation failures. - - - `"error"` - - - `output_text: optional string or null` - - SDK-only convenience property that contains the aggregated text output - from all `output_text` items in the `output` array, if any are present. - Supported in the Python and JavaScript SDKs. - - - `previous_response_id: optional string or null` - - The unique ID of the previous response to the model. Use this to - create multi-turn conversations. Learn more about - [conversation state](/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`. - - - `prompt: optional ResponsePrompt or null` - - Reference to a prompt template and its variables. - [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). - - - `id: string` - - The unique identifier of the prompt template to use. - - - `variables: optional map[string or ResponseInputText or ResponseInputImage or ResponseInputFile] or null` - - Optional map of values to substitute in for variables in your - prompt. The substitution values can either be strings, or other - Response input types like images or files. - - - `string` - - - `ResponseInputText object { text, type, prompt_cache_breakpoint }` - - A text input to the model. - - - `ResponseInputImage object { detail, type, file_id, 2 more }` - - An image input to the model. Learn about [image inputs](/docs/guides/vision). - - - `ResponseInputFile object { type, detail, file_data, 4 more }` - - A file input to the model. - - - `version: optional string or null` - - Optional version of the prompt template. - - - `prompt_cache_key: optional string or null` - - Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching). - - - `prompt_cache_options: optional object { mode, ttl }` - - The prompt-caching options that were applied to the response. Supported for `gpt-5.6` and later models. - - - `mode: "implicit" or "explicit"` - - Whether implicit prompt-cache breakpoints were enabled. - - - `"implicit"` - - - `"explicit"` - - - `ttl: "30m"` - - The minimum lifetime applied to each cache breakpoint. - - - `"30m"` - - - `prompt_cache_retention: optional "in_memory" or "24h" or null` - - 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](/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. - For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. - - For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: - - - Organizations without ZDR enabled default to `24h`. - - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified. - - - `"in_memory"` - - - `"24h"` - - - `reasoning: optional Reasoning or null` - - **gpt-5 and o-series models only** - - Configuration options for - [reasoning models](https://platform.openai.com/docs/guides/reasoning). - - - `context: optional "auto" or "current_turn" or "all_turns" or null` - - Controls which reasoning items are rendered back to the model on later turns. - If omitted or set to `auto`, the model determines the context mode. The - `gpt-5.6` model family defaults to `all_turns`; earlier models default to - `current_turn`. - - When returned on a response, this is the effective reasoning context mode - used for the response. - - - `"auto"` - - - `"current_turn"` - - - `"all_turns"` - - - `effort: optional ReasoningEffort or null` - - Constrains effort on reasoning for reasoning models. Currently supported - values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. - 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) - for model-specific support. - - - `"none"` - - - `"minimal"` - - - `"low"` - - - `"medium"` - - - `"high"` - - - `"xhigh"` - - - `"max"` - - - `generate_summary: optional "auto" or "concise" or "detailed" or null` - - **Deprecated:** use `summary` instead. - - A summary of the reasoning performed by the model. This can be - useful for debugging and understanding the model's reasoning process. - One of `auto`, `concise`, or `detailed`. - - - `"auto"` - - - `"concise"` - - - `"detailed"` - - - `mode: optional string or "standard" or "pro"` - - Controls the reasoning execution mode for the request. - - When returned on a response, this is the effective execution mode. - - - `string` - - - `"standard" or "pro"` - - Controls the reasoning execution mode for the request. - - When returned on a response, this is the effective execution mode. - - - `"standard"` - - - `"pro"` - - - `summary: optional "auto" or "concise" or "detailed" or null` - - A summary of the reasoning performed by the model. This can be - useful for debugging and understanding the model's reasoning process. - One of `auto`, `concise`, or `detailed`. - - `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`. - - - `"auto"` - - - `"concise"` - - - `"detailed"` - - - `safety_identifier: optional string or null` - - 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](/docs/guides/safety-best-practices#safety-identifiers). - - - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` - - 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](/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. - - 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. - - - `"auto"` - - - `"default"` - - - `"flex"` - - - `"scale"` - - - `"priority"` - - - `"fast"` - - - `status: optional ResponseStatus` - - The status of the response generation. One of `completed`, `failed`, - `in_progress`, `cancelled`, `queued`, or `incomplete`. - - - `"completed"` - - - `"failed"` - - - `"in_progress"` - - - `"cancelled"` - - - `"queued"` - - - `"incomplete"` - - - `text: optional ResponseTextConfig` - - Configuration options for a text response from the model. Can be plain - text or structured JSON data. Learn more: - - - [Text inputs and outputs](/docs/guides/text) - - [Structured Outputs](/docs/guides/structured-outputs) - - - `format: optional ResponseFormatTextConfig` - - 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](/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. - - - `ResponseFormatText object { type }` - - Default response format. Used to generate text responses. - - - `type: "text"` - - The type of response format being defined. Always `text`. - - - `"text"` - - - `ResponseFormatTextJSONSchemaConfig object { name, schema, type, 2 more }` - - JSON Schema response format. Used to generate structured JSON responses. - Learn more about [Structured Outputs](/docs/guides/structured-outputs). - - - `name: string` - - The name of the response format. Must be a-z, A-Z, 0-9, or contain - underscores and dashes, with a maximum length of 64. - - - `schema: map[unknown]` - - The schema for the response format, described as a JSON Schema object. - Learn how to build JSON schemas [here](https://json-schema.org/). - - - `type: "json_schema"` - - The type of response format being defined. Always `json_schema`. - - - `"json_schema"` - - - `description: optional string` - - A description of what the response format is for, used by the model to - determine how to respond in the format. - - - `strict: optional boolean or null` - - Whether to enable strict schema adherence when generating the output. - 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](/docs/guides/structured-outputs). - - - `ResponseFormatJSONObject object { type }` - - JSON object response format. An older method of generating JSON responses. - Using `json_schema` is recommended for models that support it. Note that the - model will not generate JSON without a system or user message instructing it - to do so. - - - `type: "json_object"` - - The type of response format being defined. Always `json_object`. - - - `"json_object"` - - - `verbosity: optional "low" or "medium" or "high" or null` - - Constrains the verbosity of the model's response. Lower values will result in - more concise responses, while higher values will result in more verbose responses. - Currently supported values are `low`, `medium`, and `high`. The default is - `medium`. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `top_logprobs: optional number or null` - - An integer between 0 and 20 specifying the maximum number of most likely - tokens to return at each token position, each with an associated log - probability. In some cases, the number of returned tokens may be fewer than - requested. - - - `truncation: optional "auto" or "disabled" or null` - - The truncation strategy to use for the model response. - - - `auto`: If the input to this Response exceeds - the model's context window size, the model will truncate the - response to fit the context window by dropping items from the beginning of the conversation. - - `disabled` (default): If the input size will exceed the context window - size for a model, the request will fail with a 400 error. - - - `"auto"` - - - `"disabled"` - - - `usage: optional ResponseUsage` - - Represents token usage details including input tokens, output tokens, - a breakdown of output tokens, and the total tokens used. - - - `input_tokens: number` - - The number of input tokens. - - - `input_tokens_details: object { cache_write_tokens, cached_tokens }` - - A detailed breakdown of the input tokens. - - - `cache_write_tokens: number` - - The number of input tokens that were written to the cache. - - - `cached_tokens: number` - - The number of tokens that were retrieved from the cache. - [More on prompt caching](/docs/guides/prompt-caching). - - - `output_tokens: number` - - The number of output tokens. - - - `output_tokens_details: object { reasoning_tokens }` - - A detailed breakdown of the output tokens. - - - `reasoning_tokens: number` - - The number of reasoning tokens. - - - `total_tokens: number` - - The total number of tokens used. - - - `user: optional string` - - 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](/docs/guides/safety-best-practices#safety-identifiers). - - - `sequence_number: number` - - The sequence number for this event. - - - `type: "response.completed"` - - The type of the event. Always `response.completed`. - - - `"response.completed"` - - - `ResponseContentPartAddedEvent object { content_index, item_id, output_index, 3 more }` - - Emitted when a new content part is added. - - - `content_index: number` - - The index of the content part that was added. - - - `item_id: string` - - The ID of the output item that the content part was added to. - - - `output_index: number` - - The index of the output item that the content part was added to. - - - `part: ResponseOutputText or ResponseOutputRefusal or object { text, type }` - - The content part that was added. - - - `ResponseOutputText object { annotations, logprobs, text, type }` - - A text output from the model. - - - `ResponseOutputRefusal object { refusal, type }` - - A refusal from the model. - - - `ReasoningText object { text, type }` - - Reasoning text from the model. - - - `text: string` - - The reasoning text from the model. - - - `type: "reasoning_text"` - - The type of the reasoning text. Always `reasoning_text`. - - - `"reasoning_text"` - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.content_part.added"` - - The type of the event. Always `response.content_part.added`. - - - `"response.content_part.added"` - - - `ResponseContentPartDoneEvent object { content_index, item_id, output_index, 3 more }` - - Emitted when a content part is done. - - - `content_index: number` - - The index of the content part that is done. - - - `item_id: string` - - The ID of the output item that the content part was added to. - - - `output_index: number` - - The index of the output item that the content part was added to. - - - `part: ResponseOutputText or ResponseOutputRefusal or object { text, type }` - - The content part that is done. - - - `ResponseOutputText object { annotations, logprobs, text, type }` - - A text output from the model. - - - `ResponseOutputRefusal object { refusal, type }` - - A refusal from the model. - - - `ReasoningText object { text, type }` - - Reasoning text from the model. - - - `text: string` - - The reasoning text from the model. - - - `type: "reasoning_text"` - - The type of the reasoning text. Always `reasoning_text`. - - - `"reasoning_text"` - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.content_part.done"` - - The type of the event. Always `response.content_part.done`. - - - `"response.content_part.done"` - - - `ResponseCreatedEvent object { response, sequence_number, type }` - - An event that is emitted when a response is created. - - - `response: Response` - - The response that was created. - - - `sequence_number: number` - - The sequence number for this event. - - - `type: "response.created"` - - The type of the event. Always `response.created`. - - - `"response.created"` - - - `ResponseErrorEvent object { code, message, param, 2 more }` - - Emitted when an error occurs. - - - `code: string or null` - - The error code. - - - `message: string` - - The error message. - - - `param: string or null` - - The error parameter. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "error"` - - The type of the event. Always `error`. - - - `"error"` - - - `ResponseFileSearchCallCompletedEvent object { item_id, output_index, sequence_number, type }` - - Emitted when a file search call is completed (results found). - - - `item_id: string` - - The ID of the output item that the file search call is initiated. - - - `output_index: number` - - The index of the output item that the file search call is initiated. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.file_search_call.completed"` - - The type of the event. Always `response.file_search_call.completed`. - - - `"response.file_search_call.completed"` - - - `ResponseFileSearchCallInProgressEvent object { item_id, output_index, sequence_number, type }` - - Emitted when a file search call is initiated. - - - `item_id: string` - - The ID of the output item that the file search call is initiated. - - - `output_index: number` - - The index of the output item that the file search call is initiated. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.file_search_call.in_progress"` - - The type of the event. Always `response.file_search_call.in_progress`. - - - `"response.file_search_call.in_progress"` - - - `ResponseFileSearchCallSearchingEvent object { item_id, output_index, sequence_number, type }` - - Emitted when a file search is currently searching. - - - `item_id: string` - - The ID of the output item that the file search call is initiated. - - - `output_index: number` - - The index of the output item that the file search call is searching. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.file_search_call.searching"` - - The type of the event. Always `response.file_search_call.searching`. - - - `"response.file_search_call.searching"` - - - `ResponseFunctionCallArgumentsDeltaEvent object { delta, item_id, output_index, 2 more }` - - Emitted when there is a partial function-call arguments delta. - - - `delta: string` - - The function-call arguments delta that is added. - - - `item_id: string` - - The ID of the output item that the function-call arguments delta is added to. - - - `output_index: number` - - The index of the output item that the function-call arguments delta is added to. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.function_call_arguments.delta"` - - The type of the event. Always `response.function_call_arguments.delta`. - - - `"response.function_call_arguments.delta"` - - - `ResponseFunctionCallArgumentsDoneEvent object { arguments, item_id, name, 3 more }` - - Emitted when function-call arguments are finalized. - - - `arguments: string` - - The function-call arguments. - - - `item_id: string` - - The ID of the item. - - - `name: string` - - The name of the function that was called. - - - `output_index: number` - - The index of the output item. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.function_call_arguments.done"` - - - `"response.function_call_arguments.done"` - - - `ResponseInProgressEvent object { response, sequence_number, type }` - - Emitted when the response is in progress. - - - `response: Response` - - The response that is in progress. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.in_progress"` - - The type of the event. Always `response.in_progress`. - - - `"response.in_progress"` - - - `ResponseFailedEvent object { response, sequence_number, type }` - - An event that is emitted when a response fails. - - - `response: Response` - - The response that failed. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.failed"` - - The type of the event. Always `response.failed`. - - - `"response.failed"` - - - `ResponseIncompleteEvent object { response, sequence_number, type }` - - An event that is emitted when a response finishes as incomplete. - - - `response: Response` - - The response that was incomplete. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.incomplete"` - - The type of the event. Always `response.incomplete`. - - - `"response.incomplete"` - - - `ResponseOutputItemAddedEvent object { item, output_index, sequence_number, type }` - - Emitted when a new output item is added. - - - `item: ResponseOutputItem` - - The output item that was added. - - - `ResponseOutputMessage object { id, content, role, 3 more }` - - An output message from the model. - - - `FileSearchCall object { id, queries, status, 2 more }` - - The results of a file search tool call. See the - [file search guide](/docs/guides/tools-file-search) for more information. - - - `FunctionCall object { arguments, call_id, name, 5 more }` - - A tool call to run a function. See the - [function calling guide](/docs/guides/function-calling) for more information. - - - `FunctionCallOutput object { id, output, status, 6 more }` - - - `WebSearchCall object { id, action, status, type }` - - The results of a web search tool call. See the - [web search guide](/docs/guides/tools-web-search) for more information. - - - `ComputerCall object { id, call_id, pending_safety_checks, 4 more }` - - A tool call to a computer use tool. See the - [computer use guide](/docs/guides/tools-computer-use) for more information. - - - `ComputerCallOutput object { id, call_id, output, 4 more }` - - - `Reasoning object { id, summary, type, 3 more }` - - 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](/docs/guides/conversation-state). - - - `Program object { id, call_id, code, 2 more }` - - - `ProgramOutput object { id, call_id, result, 2 more }` - - - `ToolSearchCall object { id, arguments, call_id, 4 more }` - - - `ToolSearchOutput object { id, call_id, execution, 4 more }` - - - `AdditionalTools object { id, role, tools, type }` - - - `Compaction object { id, encrypted_content, type, created_by }` - - A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). - - - `ImageGenerationCall object { id, result, status, type }` - - An image generation request made by the model. - - - `CodeInterpreterCall object { id, code, container_id, 3 more }` - - A tool call to run code. - - - `LocalShellCall object { id, action, call_id, 2 more }` - - A tool call to run a command on the local shell. - - - `LocalShellCallOutput object { id, output, type, status }` - - The output of a local shell tool call. - - - `ShellCall object { id, action, call_id, 5 more }` - - A tool call that executes one or more shell commands in a managed environment. - - - `ShellCallOutput object { id, call_id, max_output_length, 5 more }` - - The output of a shell tool call that was emitted. - - - `ApplyPatchCall object { id, call_id, operation, 4 more }` - - A tool call that applies file diffs by creating, deleting, or updating files. - - - `ApplyPatchCallOutput object { id, call_id, status, 4 more }` - - The output emitted by an apply patch tool call. - - - `McpCall object { id, arguments, name, 6 more }` - - An invocation of a tool on an MCP server. - - - `McpListTools object { id, server_label, tools, 2 more }` - - A list of tools available on an MCP server. - - - `McpApprovalRequest object { id, arguments, name, 2 more }` - - A request for human approval of a tool invocation. - - - `McpApprovalResponse object { id, approval_request_id, approve, 2 more }` - - A response to an MCP approval request. - - - `CustomToolCall object { call_id, input, name, 4 more }` - - A call to a custom tool created by the model. - - - `CustomToolCallOutput object { id, call_id, output, 4 more }` - - - `output_index: number` - - The index of the output item that was added. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.output_item.added"` - - The type of the event. Always `response.output_item.added`. - - - `"response.output_item.added"` - - - `ResponseOutputItemDoneEvent object { item, output_index, sequence_number, type }` - - Emitted when an output item is marked done. - - - `item: ResponseOutputItem` - - The output item that was marked done. - - - `output_index: number` - - The index of the output item that was marked done. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.output_item.done"` - - The type of the event. Always `response.output_item.done`. - - - `"response.output_item.done"` - - - `ResponseReasoningSummaryPartAddedEvent object { item_id, output_index, part, 3 more }` - - Emitted when a new reasoning summary part is added. - - - `item_id: string` - - The ID of the item this summary part is associated with. - - - `output_index: number` - - The index of the output item this summary part is associated with. - - - `part: object { text, type }` - - The summary part that was added. - - - `text: string` - - The text of the summary part. - - - `type: "summary_text"` - - The type of the summary part. Always `summary_text`. - - - `"summary_text"` - - - `sequence_number: number` - - The sequence number of this event. - - - `summary_index: number` - - The index of the summary part within the reasoning summary. - - - `type: "response.reasoning_summary_part.added"` - - The type of the event. Always `response.reasoning_summary_part.added`. - - - `"response.reasoning_summary_part.added"` - - - `ResponseReasoningSummaryPartDoneEvent object { item_id, output_index, part, 4 more }` - - Emitted when a reasoning summary part is completed. - - - `item_id: string` - - The ID of the item this summary part is associated with. - - - `output_index: number` - - The index of the output item this summary part is associated with. - - - `part: object { text, type }` - - The completed summary part. - - - `text: string` - - The text of the summary part. - - - `type: "summary_text"` - - The type of the summary part. Always `summary_text`. - - - `"summary_text"` - - - `sequence_number: number` - - The sequence number of this event. - - - `summary_index: number` - - The index of the summary part within the reasoning summary. - - - `type: "response.reasoning_summary_part.done"` - - The type of the event. Always `response.reasoning_summary_part.done`. - - - `"response.reasoning_summary_part.done"` - - - `status: optional "incomplete"` - - The completion status of the summary part. Omitted when the part completed - normally and set to `incomplete` when generation was interrupted. - - - `"incomplete"` - - - `ResponseReasoningSummaryTextDeltaEvent object { delta, item_id, output_index, 3 more }` - - Emitted when a delta is added to a reasoning summary text. - - - `delta: string` - - The text delta that was added to the summary. - - - `item_id: string` - - The ID of the item this summary text delta is associated with. - - - `output_index: number` - - The index of the output item this summary text delta is associated with. - - - `sequence_number: number` - - The sequence number of this event. - - - `summary_index: number` - - The index of the summary part within the reasoning summary. - - - `type: "response.reasoning_summary_text.delta"` - - The type of the event. Always `response.reasoning_summary_text.delta`. - - - `"response.reasoning_summary_text.delta"` - - - `ResponseReasoningSummaryTextDoneEvent object { item_id, output_index, sequence_number, 3 more }` - - Emitted when a reasoning summary text is completed. - - - `item_id: string` - - The ID of the item this summary text is associated with. - - - `output_index: number` - - The index of the output item this summary text is associated with. - - - `sequence_number: number` - - The sequence number of this event. - - - `summary_index: number` - - The index of the summary part within the reasoning summary. - - - `text: string` - - The full text of the completed reasoning summary. - - - `type: "response.reasoning_summary_text.done"` - - The type of the event. Always `response.reasoning_summary_text.done`. - - - `"response.reasoning_summary_text.done"` - - - `ResponseReasoningTextDeltaEvent object { content_index, delta, item_id, 3 more }` - - Emitted when a delta is added to a reasoning text. - - - `content_index: number` - - The index of the reasoning content part this delta is associated with. - - - `delta: string` - - The text delta that was added to the reasoning content. - - - `item_id: string` - - The ID of the item this reasoning text delta is associated with. - - - `output_index: number` - - The index of the output item this reasoning text delta is associated with. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.reasoning_text.delta"` - - The type of the event. Always `response.reasoning_text.delta`. - - - `"response.reasoning_text.delta"` - - - `ResponseReasoningTextDoneEvent object { content_index, item_id, output_index, 3 more }` - - Emitted when a reasoning text is completed. - - - `content_index: number` - - The index of the reasoning content part. - - - `item_id: string` - - The ID of the item this reasoning text is associated with. - - - `output_index: number` - - The index of the output item this reasoning text is associated with. - - - `sequence_number: number` - - The sequence number of this event. - - - `text: string` - - The full text of the completed reasoning content. - - - `type: "response.reasoning_text.done"` - - The type of the event. Always `response.reasoning_text.done`. - - - `"response.reasoning_text.done"` - - - `ResponseRefusalDeltaEvent object { content_index, delta, item_id, 3 more }` - - Emitted when there is a partial refusal text. - - - `content_index: number` - - The index of the content part that the refusal text is added to. - - - `delta: string` - - The refusal text that is added. - - - `item_id: string` - - The ID of the output item that the refusal text is added to. - - - `output_index: number` - - The index of the output item that the refusal text is added to. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.refusal.delta"` - - The type of the event. Always `response.refusal.delta`. - - - `"response.refusal.delta"` - - - `ResponseRefusalDoneEvent object { content_index, item_id, output_index, 3 more }` - - Emitted when refusal text is finalized. - - - `content_index: number` - - The index of the content part that the refusal text is finalized. - - - `item_id: string` - - The ID of the output item that the refusal text is finalized. - - - `output_index: number` - - The index of the output item that the refusal text is finalized. - - - `refusal: string` - - The refusal text that is finalized. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.refusal.done"` - - The type of the event. Always `response.refusal.done`. - - - `"response.refusal.done"` - - - `ResponseTextDeltaEvent object { content_index, delta, item_id, 4 more }` - - Emitted when there is an additional text delta. - - - `content_index: number` - - The index of the content part that the text delta was added to. - - - `delta: string` - - The text delta that was added. - - - `item_id: string` - - The ID of the output item that the text delta was added to. - - - `logprobs: array of object { token, logprob, top_logprobs }` - - The log probabilities of the tokens in the delta. - - - `token: string` - - A possible text token. - - - `logprob: number` - - The log probability of this token. - - - `top_logprobs: optional array of object { token, logprob }` - - The log probabilities of up to 20 of the most likely tokens. - - - `token: optional string` - - A possible text token. - - - `logprob: optional number` - - The log probability of this token. - - - `output_index: number` - - The index of the output item that the text delta was added to. - - - `sequence_number: number` - - The sequence number for this event. - - - `type: "response.output_text.delta"` - - The type of the event. Always `response.output_text.delta`. - - - `"response.output_text.delta"` - - - `ResponseTextDoneEvent object { content_index, item_id, logprobs, 4 more }` - - Emitted when text content is finalized. - - - `content_index: number` - - The index of the content part that the text content is finalized. - - - `item_id: string` - - The ID of the output item that the text content is finalized. - - - `logprobs: array of object { token, logprob, top_logprobs }` - - The log probabilities of the tokens in the delta. - - - `token: string` - - A possible text token. - - - `logprob: number` - - The log probability of this token. - - - `top_logprobs: optional array of object { token, logprob }` - - The log probabilities of up to 20 of the most likely tokens. - - - `token: optional string` - - A possible text token. - - - `logprob: optional number` - - The log probability of this token. - - - `output_index: number` - - The index of the output item that the text content is finalized. - - - `sequence_number: number` - - The sequence number for this event. - - - `text: string` - - The text content that is finalized. - - - `type: "response.output_text.done"` - - The type of the event. Always `response.output_text.done`. - - - `"response.output_text.done"` - - - `ResponseWebSearchCallCompletedEvent object { item_id, output_index, sequence_number, type }` - - Emitted when a web search call is completed. - - - `item_id: string` - - Unique ID for the output item associated with the web search call. - - - `output_index: number` - - The index of the output item that the web search call is associated with. - - - `sequence_number: number` - - The sequence number of the web search call being processed. - - - `type: "response.web_search_call.completed"` - - The type of the event. Always `response.web_search_call.completed`. - - - `"response.web_search_call.completed"` - - - `ResponseWebSearchCallInProgressEvent object { item_id, output_index, sequence_number, type }` - - Emitted when a web search call is initiated. - - - `item_id: string` - - Unique ID for the output item associated with the web search call. - - - `output_index: number` - - The index of the output item that the web search call is associated with. - - - `sequence_number: number` - - The sequence number of the web search call being processed. - - - `type: "response.web_search_call.in_progress"` - - The type of the event. Always `response.web_search_call.in_progress`. - - - `"response.web_search_call.in_progress"` - - - `ResponseWebSearchCallSearchingEvent object { item_id, output_index, sequence_number, type }` - - Emitted when a web search call is executing. - - - `item_id: string` - - Unique ID for the output item associated with the web search call. - - - `output_index: number` - - The index of the output item that the web search call is associated with. - - - `sequence_number: number` - - The sequence number of the web search call being processed. - - - `type: "response.web_search_call.searching"` - - The type of the event. Always `response.web_search_call.searching`. - - - `"response.web_search_call.searching"` - - - `ResponseImageGenCallCompletedEvent object { item_id, output_index, sequence_number, type }` - - Emitted when an image generation tool call has completed and the final image is available. - - - `item_id: string` - - The unique identifier of the image generation item being processed. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.image_generation_call.completed"` - - The type of the event. Always 'response.image_generation_call.completed'. - - - `"response.image_generation_call.completed"` - - - `ResponseImageGenCallGeneratingEvent object { item_id, output_index, sequence_number, type }` - - Emitted when an image generation tool call is actively generating an image (intermediate state). - - - `item_id: string` - - The unique identifier of the image generation item being processed. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `sequence_number: number` - - The sequence number of the image generation item being processed. - - - `type: "response.image_generation_call.generating"` - - The type of the event. Always 'response.image_generation_call.generating'. - - - `"response.image_generation_call.generating"` - - - `ResponseImageGenCallInProgressEvent object { item_id, output_index, sequence_number, type }` - - Emitted when an image generation tool call is in progress. - - - `item_id: string` - - The unique identifier of the image generation item being processed. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `sequence_number: number` - - The sequence number of the image generation item being processed. - - - `type: "response.image_generation_call.in_progress"` - - The type of the event. Always 'response.image_generation_call.in_progress'. - - - `"response.image_generation_call.in_progress"` - - - `ResponseImageGenCallPartialImageEvent object { item_id, output_index, partial_image_b64, 3 more }` - - Emitted when a partial image is available during image generation streaming. - - - `item_id: string` - - The unique identifier of the image generation item being processed. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `partial_image_b64: string` - - Base64-encoded partial image data, suitable for rendering as an image. - - - `partial_image_index: number` - - 0-based index for the partial image (backend is 1-based, but this is 0-based for the user). - - - `sequence_number: number` - - The sequence number of the image generation item being processed. - - - `type: "response.image_generation_call.partial_image"` - - The type of the event. Always 'response.image_generation_call.partial_image'. - - - `"response.image_generation_call.partial_image"` - - - `ResponseMcpCallArgumentsDeltaEvent object { delta, item_id, output_index, 2 more }` - - Emitted when there is a delta (partial update) to the arguments of an MCP tool call. - - - `delta: string` - - A JSON string containing the partial update to the arguments for the MCP tool call. - - - `item_id: string` - - The unique identifier of the MCP tool call item being processed. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_call_arguments.delta"` - - The type of the event. Always 'response.mcp_call_arguments.delta'. - - - `"response.mcp_call_arguments.delta"` - - - `ResponseMcpCallArgumentsDoneEvent object { arguments, item_id, output_index, 2 more }` - - Emitted when the arguments for an MCP tool call are finalized. - - - `arguments: string` - - A JSON string containing the finalized arguments for the MCP tool call. - - - `item_id: string` - - The unique identifier of the MCP tool call item being processed. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_call_arguments.done"` - - The type of the event. Always 'response.mcp_call_arguments.done'. - - - `"response.mcp_call_arguments.done"` - - - `ResponseMcpCallCompletedEvent object { item_id, output_index, sequence_number, type }` - - Emitted when an MCP tool call has completed successfully. - - - `item_id: string` - - The ID of the MCP tool call item that completed. - - - `output_index: number` - - The index of the output item that completed. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_call.completed"` - - The type of the event. Always 'response.mcp_call.completed'. - - - `"response.mcp_call.completed"` - - - `ResponseMcpCallFailedEvent object { item_id, output_index, sequence_number, type }` - - Emitted when an MCP tool call has failed. - - - `item_id: string` - - The ID of the MCP tool call item that failed. - - - `output_index: number` - - The index of the output item that failed. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_call.failed"` - - The type of the event. Always 'response.mcp_call.failed'. - - - `"response.mcp_call.failed"` - - - `ResponseMcpCallInProgressEvent object { item_id, output_index, sequence_number, type }` - - Emitted when an MCP tool call is in progress. - - - `item_id: string` - - The unique identifier of the MCP tool call item being processed. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_call.in_progress"` - - The type of the event. Always 'response.mcp_call.in_progress'. - - - `"response.mcp_call.in_progress"` - - - `ResponseMcpListToolsCompletedEvent object { item_id, output_index, sequence_number, type }` - - Emitted when the list of available MCP tools has been successfully retrieved. - - - `item_id: string` - - The ID of the MCP tool call item that produced this output. - - - `output_index: number` - - The index of the output item that was processed. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_list_tools.completed"` - - The type of the event. Always 'response.mcp_list_tools.completed'. - - - `"response.mcp_list_tools.completed"` - - - `ResponseMcpListToolsFailedEvent object { item_id, output_index, sequence_number, type }` - - Emitted when the attempt to list available MCP tools has failed. - - - `item_id: string` - - The ID of the MCP tool call item that failed. - - - `output_index: number` - - The index of the output item that failed. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_list_tools.failed"` - - The type of the event. Always 'response.mcp_list_tools.failed'. - - - `"response.mcp_list_tools.failed"` - - - `ResponseMcpListToolsInProgressEvent object { item_id, output_index, sequence_number, type }` - - Emitted when the system is in the process of retrieving the list of available MCP tools. - - - `item_id: string` - - The ID of the MCP tool call item that is being processed. - - - `output_index: number` - - The index of the output item that is being processed. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.mcp_list_tools.in_progress"` - - The type of the event. Always 'response.mcp_list_tools.in_progress'. - - - `"response.mcp_list_tools.in_progress"` - - - `ResponseOutputTextAnnotationAddedEvent object { annotation, annotation_index, content_index, 4 more }` - - Emitted when an annotation is added to output text content. - - - `annotation: unknown` - - The annotation object being added. (See annotation schema for details.) - - - `annotation_index: number` - - The index of the annotation within the content part. - - - `content_index: number` - - The index of the content part within the output item. - - - `item_id: string` - - The unique identifier of the item to which the annotation is being added. - - - `output_index: number` - - The index of the output item in the response's output array. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.output_text.annotation.added"` - - The type of the event. Always 'response.output_text.annotation.added'. - - - `"response.output_text.annotation.added"` - - - `ResponseQueuedEvent object { response, sequence_number, type }` - - Emitted when a response is queued and waiting to be processed. - - - `response: Response` - - The full response object that is queued. - - - `sequence_number: number` - - The sequence number for this event. - - - `type: "response.queued"` - - The type of the event. Always 'response.queued'. - - - `"response.queued"` - - - `ResponseCustomToolCallInputDeltaEvent object { delta, item_id, output_index, 2 more }` - - Event representing a delta (partial update) to the input of a custom tool call. - - - `delta: string` - - The incremental input data (delta) for the custom tool call. - - - `item_id: string` - - Unique identifier for the API item associated with this event. - - - `output_index: number` - - The index of the output this delta applies to. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.custom_tool_call_input.delta"` - - The event type identifier. - - - `"response.custom_tool_call_input.delta"` - - - `ResponseCustomToolCallInputDoneEvent object { input, item_id, output_index, 2 more }` - - Event indicating that input for a custom tool call is complete. - - - `input: string` - - The complete input data for the custom tool call. - - - `item_id: string` - - Unique identifier for the API item associated with this event. - - - `output_index: number` - - The index of the output this event applies to. - - - `sequence_number: number` - - The sequence number of this event. - - - `type: "response.custom_tool_call_input.done"` - - The event type identifier. - - - `"response.custom_tool_call_input.done"` - -### Skill Reference - -- `SkillReference object { skill_id, type, version }` - - - `skill_id: string` - - The ID of the referenced skill. - - - `type: "skill_reference"` - - References a skill created with the /v1/skills endpoint. - - - `"skill_reference"` - - - `version: optional string` - - Optional skill version. Use a positive integer or 'latest'. Omit for default. - -### Tool Choice Allowed - -- `ToolChoiceAllowed object { mode, tools, type }` - - Constrains the tools available to the model to a pre-defined set. - - - `mode: "auto" or "required"` - - Constrains the tools available to the model to a pre-defined set. - - `auto` allows the model to pick from among the allowed tools and generate a - message. - - `required` requires the model to call one or more of the allowed tools. - - - `"auto"` - - - `"required"` - - - `tools: array of map[unknown]` - - A list of tool definitions that the model should be allowed to call. - - For the Responses API, the list of tool definitions might look like: - - ```json - [ - { "type": "function", "name": "get_weather" }, - { "type": "mcp", "server_label": "deepwiki" }, - { "type": "image_generation" } - ] - ``` - - - `type: "allowed_tools"` - - Allowed tool configuration type. Always `allowed_tools`. - - - `"allowed_tools"` - -### Tool Choice Apply Patch - -- `ToolChoiceApplyPatch object { type }` - - Forces the model to call the apply_patch tool when executing a tool call. - - - `type: "apply_patch"` - - The tool to call. Always `apply_patch`. - - - `"apply_patch"` - -### Tool Choice Custom - -- `ToolChoiceCustom object { name, type }` - - Use this option to force the model to call a specific custom tool. - - - `name: string` - - The name of the custom tool to call. - - - `type: "custom"` - - For custom tool calling, the type is always `custom`. - - - `"custom"` - -### Tool Choice Function - -- `ToolChoiceFunction object { name, type }` - - Use this option to force the model to call a specific function. - - - `name: string` - - The name of the function to call. - - - `type: "function"` - - For function calling, the type is always `function`. - - - `"function"` - -### Tool Choice Mcp - -- `ToolChoiceMcp object { server_label, type, name }` - - Use this option to force the model to call a specific tool on a remote MCP server. - - - `server_label: string` - - The label of the MCP server to use. - - - `type: "mcp"` - - For MCP tools, the type is always `mcp`. - - - `"mcp"` - - - `name: optional string or null` - - The name of the tool to call on the server. - -### Tool Choice Options - -- `ToolChoiceOptions = "none" or "auto" or "required"` - - Controls which (if any) tool is called by the model. - - `none` means the model will not call any tool and instead generates a message. - - `auto` means the model can pick between generating a message or calling one or - more tools. - - `required` means the model must call one or more tools. - - - `"none"` - - - `"auto"` - - - `"required"` - -### Tool Choice Shell - -- `ToolChoiceShell object { type }` - - Forces the model to call the shell tool when a tool call is required. - - - `type: "shell"` - - The tool to call. Always `shell`. - - - `"shell"` - -### Tool Choice Types - -- `ToolChoiceTypes object { type }` - - Indicates that the model should use a built-in tool to generate a response. - [Learn more about built-in tools](/docs/guides/tools). - - - `type: "file_search" or "web_search_preview" or "computer" or 5 more` - - The type of hosted tool the model should to use. Learn more about - [built-in tools](/docs/guides/tools). - - Allowed values are: - - - `file_search` - - `web_search_preview` - - `computer` - - `computer_use_preview` - - `computer_use` - - `code_interpreter` - - `image_generation` - - - `"file_search"` - - - `"web_search_preview"` - - - `"computer"` - - - `"computer_use_preview"` - - - `"computer_use"` - - - `"web_search_preview_2025_03_11"` - - - `"image_generation"` - - - `"code_interpreter"` - -# Input Items - -## List input items - -**get** `/responses/{response_id}/input_items` - -Returns a list of input items for a given response. - -### Path Parameters - -- `response_id: string` - -### Query Parameters - -- `after: optional string` - - An item ID to list items after, used in pagination. - -- `include: optional array of ResponseIncludable` - - Additional fields to include in the response. See the `include` - parameter for Response creation above for more information. - - - `"file_search_call.results"` - - - `"web_search_call.results"` - - - `"web_search_call.action.sources"` - - - `"message.input_image.image_url"` - - - `"computer_call_output.output.image_url"` - - - `"code_interpreter_call.outputs"` - - - `"reasoning.encrypted_content"` - - - `"message.output_text.logprobs"` - -- `limit: optional number` - - A limit on the number of objects to be returned. Limit can range between - 1 and 100, and the default is 20. - -- `order: optional "asc" or "desc"` - - The order to return the input items in. Default is `desc`. - - - `asc`: Return the input items in ascending order. - - `desc`: Return the input items in descending order. - - - `"asc"` - - - `"desc"` - -### Returns - -- `ResponseItemList object { data, first_id, has_more, 2 more }` - - A list of Response items. - - - `data: array of ResponseInputMessageItem or ResponseOutputMessage or object { id, queries, status, 2 more } or 26 more` - - A list of items used to generate this response. - - - `ResponseInputMessageItem object { id, content, role, 2 more }` - - - `id: string` - - The unique ID of the message input. - - - `content: ResponseInputMessageContentList` - - A list of one or many input items to the model, containing different content - types. - - - `ResponseInputText object { text, type, prompt_cache_breakpoint }` - - A text input to the model. - - - `text: string` - - The text input to the model. - - - `type: "input_text"` - - The type of the input item. Always `input_text`. - - - `"input_text"` - - - `prompt_cache_breakpoint: optional object { mode }` - - Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block. - - - `mode: "explicit"` - - The breakpoint mode. Always `explicit`. - - - `"explicit"` - - - `ResponseInputImage object { detail, type, file_id, 2 more }` - - An image input to the model. Learn about [image inputs](/docs/guides/vision). - - - `detail: "low" or "high" or "auto" or "original"` - - The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. - - - `"low"` - - - `"high"` - - - `"auto"` - - - `"original"` - - - `type: "input_image"` - - The type of the input item. Always `input_image`. - - - `"input_image"` - - - `file_id: optional string or null` - - The ID of the file to be sent to the model. - - - `image_url: optional string or null` - - The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. - - - `prompt_cache_breakpoint: optional object { mode }` - - Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block. - - - `mode: "explicit"` - - The breakpoint mode. Always `explicit`. - - - `"explicit"` - - - `ResponseInputFile object { type, detail, file_data, 4 more }` - - A file input to the model. - - - `type: "input_file"` - - The type of the input item. Always `input_file`. - - - `"input_file"` - - - `detail: optional "auto" or "low" or "high"` - - The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`. - - - `"auto"` - - - `"low"` - - - `"high"` - - - `file_data: optional string` - - The content of the file to be sent to the model. - - - `file_id: optional string or null` - - The ID of the file to be sent to the model. - - - `file_url: optional string` - - The URL of the file to be sent to the model. - - - `filename: optional string` - - The name of the file to be sent to the model. - - - `prompt_cache_breakpoint: optional object { mode }` - - Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block. - - - `mode: "explicit"` - - The breakpoint mode. Always `explicit`. - - - `"explicit"` - - - `role: "user" or "system" or "developer"` - - The role of the message input. One of `user`, `system`, or `developer`. - - - `"user"` - - - `"system"` - - - `"developer"` - - - `type: "message"` - - The type of the message input. Always set to `message`. - - - `"message"` - - - `status: optional "in_progress" or "completed" or "incomplete"` - - The status of item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `ResponseOutputMessage object { id, content, role, 3 more }` - - An output message from the model. - - - `id: string` - - The unique ID of the output message. - - - `content: array of ResponseOutputText or ResponseOutputRefusal` - - The content of the output message. - - - `ResponseOutputText object { annotations, logprobs, text, type }` - - A text output from the model. - - - `annotations: array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more } or object { file_id, index, type }` - - The annotations of the text output. - - - `FileCitation object { file_id, filename, index, type }` - - A citation to a file. - - - `file_id: string` - - The ID of the file. - - - `filename: string` - - The filename of the file cited. - - - `index: number` - - The index of the file in the list of files. - - - `type: "file_citation"` - - The type of the file citation. Always `file_citation`. - - - `"file_citation"` - - - `URLCitation object { end_index, start_index, title, 2 more }` - - A citation for a web resource used to generate a model response. - - - `end_index: number` - - The index of the last character of the URL citation in the message. - - - `start_index: number` - - The index of the first character of the URL citation in the message. - - - `title: string` - - The title of the web resource. - - - `type: "url_citation"` - - The type of the URL citation. Always `url_citation`. - - - `"url_citation"` - - - `url: string` - - The URL of the web resource. - - - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }` - - A citation for a container file used to generate a model response. - - - `container_id: string` - - The ID of the container file. - - - `end_index: number` - - The index of the last character of the container file citation in the message. - - - `file_id: string` - - The ID of the file. - - - `filename: string` - - The filename of the container file cited. - - - `start_index: number` - - The index of the first character of the container file citation in the message. - - - `type: "container_file_citation"` - - The type of the container file citation. Always `container_file_citation`. - - - `"container_file_citation"` - - - `FilePath object { file_id, index, type }` - - A path to a file. - - - `file_id: string` - - The ID of the file. - - - `index: number` - - The index of the file in the list of files. - - - `type: "file_path"` - - The type of the file path. Always `file_path`. - - - `"file_path"` - - - `logprobs: array of object { token, bytes, logprob, top_logprobs }` - - - `token: string` - - - `bytes: array of number` - - - `logprob: number` - - - `top_logprobs: array of object { token, bytes, logprob }` - - - `token: string` - - - `bytes: array of number` - - - `logprob: number` - - - `text: string` - - The text output from the model. - - - `type: "output_text"` - - The type of the output text. Always `output_text`. - - - `"output_text"` - - - `ResponseOutputRefusal object { refusal, type }` - - A refusal from the model. - - - `refusal: string` - - The refusal explanation from the model. - - - `type: "refusal"` - - The type of the refusal. Always `refusal`. - - - `"refusal"` - - - `role: "assistant"` - - The role of the output message. Always `assistant`. - - - `"assistant"` - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the message input. One of `in_progress`, `completed`, or - `incomplete`. Populated when input items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "message"` - - The type of the output message. Always `message`. - - - `"message"` - - - `phase: optional "commentary" or "final_answer" or null` - - Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). - For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend - phase on all assistant messages — dropping it can degrade performance. Not used for user messages. - - - `"commentary"` - - - `"final_answer"` - - - `FileSearchCall object { id, queries, status, 2 more }` - - The results of a file search tool call. See the - [file search guide](/docs/guides/tools-file-search) for more information. - - - `id: string` - - The unique ID of the file search tool call. - - - `queries: array of string` - - The queries used to search for files. - - - `status: "in_progress" or "searching" or "completed" or 2 more` - - The status of the file search tool call. One of `in_progress`, - `searching`, `incomplete` or `failed`, - - - `"in_progress"` - - - `"searching"` - - - `"completed"` - - - `"incomplete"` - - - `"failed"` - - - `type: "file_search_call"` - - The type of the file search tool call. Always `file_search_call`. - - - `"file_search_call"` - - - `results: optional array of object { attributes, file_id, filename, 2 more } or null` - - The results of the file search tool call. - - - `attributes: optional map[string or number or boolean] or null` - - Set of 16 key-value pairs that can be attached to an object. This can be - useful for storing additional information about the object in a structured - format, and querying for objects via API or the dashboard. Keys are strings - with a maximum length of 64 characters. Values are strings with a maximum - length of 512 characters, booleans, or numbers. - - - `string` - - - `number` - - - `boolean` - - - `file_id: optional string` - - The unique ID of the file. - - - `filename: optional string` - - The name of the file. - - - `score: optional number` - - The relevance score of the file - a value between 0 and 1. - - - `text: optional string` - - The text that was retrieved from the file. - - - `ComputerCall object { id, call_id, pending_safety_checks, 4 more }` - - A tool call to a computer use tool. See the - [computer use guide](/docs/guides/tools-computer-use) for more information. - - - `id: string` - - The unique ID of the computer call. - - - `call_id: string` - - An identifier used when responding to the tool call with output. - - - `pending_safety_checks: array of object { id, code, message }` - - The pending safety checks for the computer call. - - - `id: string` - - The ID of the pending safety check. - - - `code: optional string or null` - - The type of the pending safety check. - - - `message: optional string or null` - - Details about the pending safety check. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "computer_call"` - - The type of the computer call. Always `computer_call`. - - - `"computer_call"` - - - `action: optional ComputerAction` - - A click action. - - - `Click object { button, type, x, 2 more }` - - A click action. - - - `button: "left" or "right" or "wheel" or 2 more` - - Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`. - - - `"left"` - - - `"right"` - - - `"wheel"` - - - `"back"` - - - `"forward"` - - - `type: "click"` - - Specifies the event type. For a click action, this property is always `click`. - - - `"click"` - - - `x: number` - - The x-coordinate where the click occurred. - - - `y: number` - - The y-coordinate where the click occurred. - - - `keys: optional array of string or null` - - The keys being held while clicking. - - - `DoubleClick object { keys, type, x, y }` - - A double click action. - - - `keys: array of string or null` - - The keys being held while double-clicking. - - - `type: "double_click"` - - Specifies the event type. For a double click action, this property is always set to `double_click`. - - - `"double_click"` - - - `x: number` - - The x-coordinate where the double click occurred. - - - `y: number` - - The y-coordinate where the double click occurred. - - - `Drag object { path, type, keys }` - - A drag action. - - - `path: array of object { x, y }` - - An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg - - ``` - [ - { x: 100, y: 200 }, - { x: 200, y: 300 } - ] - ``` - - - `x: number` - - The x-coordinate. - - - `y: number` - - The y-coordinate. - - - `type: "drag"` - - Specifies the event type. For a drag action, this property is always set to `drag`. - - - `"drag"` - - - `keys: optional array of string or null` - - The keys being held while dragging the mouse. - - - `Keypress object { keys, type }` - - A collection of keypresses the model would like to perform. - - - `keys: array of string` - - The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key. - - - `type: "keypress"` - - Specifies the event type. For a keypress action, this property is always set to `keypress`. - - - `"keypress"` - - - `Move object { type, x, y, keys }` - - A mouse move action. - - - `type: "move"` - - Specifies the event type. For a move action, this property is always set to `move`. - - - `"move"` - - - `x: number` - - The x-coordinate to move to. - - - `y: number` - - The y-coordinate to move to. - - - `keys: optional array of string or null` - - The keys being held while moving the mouse. - - - `Screenshot object { type }` - - A screenshot action. - - - `type: "screenshot"` - - Specifies the event type. For a screenshot action, this property is always set to `screenshot`. - - - `"screenshot"` - - - `Scroll object { scroll_x, scroll_y, type, 3 more }` - - A scroll action. - - - `scroll_x: number` - - The horizontal scroll distance. - - - `scroll_y: number` - - The vertical scroll distance. - - - `type: "scroll"` - - Specifies the event type. For a scroll action, this property is always set to `scroll`. - - - `"scroll"` - - - `x: number` - - The x-coordinate where the scroll occurred. - - - `y: number` - - The y-coordinate where the scroll occurred. - - - `keys: optional array of string or null` - - The keys being held while scrolling. - - - `Type object { text, type }` - - An action to type in text. - - - `text: string` - - The text to type. - - - `type: "type"` - - Specifies the event type. For a type action, this property is always set to `type`. - - - `"type"` - - - `Wait object { type }` - - A wait action. - - - `type: "wait"` - - Specifies the event type. For a wait action, this property is always set to `wait`. - - - `"wait"` - - - `actions: optional ComputerActionList` - - Flattened batched actions for `computer_use`. Each action includes an - `type` discriminator and action-specific fields. - - - `Click object { button, type, x, 2 more }` - - A click action. - - - `DoubleClick object { keys, type, x, y }` - - A double click action. - - - `Drag object { path, type, keys }` - - A drag action. - - - `Keypress object { keys, type }` - - A collection of keypresses the model would like to perform. - - - `Move object { type, x, y, keys }` - - A mouse move action. - - - `Screenshot object { type }` - - A screenshot action. - - - `Scroll object { scroll_x, scroll_y, type, 3 more }` - - A scroll action. - - - `Type object { text, type }` - - An action to type in text. - - - `Wait object { type }` - - A wait action. - - - `ComputerCallOutput object { id, call_id, output, 4 more }` - - - `id: string` - - The unique ID of the computer call tool output. - - - `call_id: string` - - The ID of the computer tool call that produced the output. - - - `output: ResponseComputerToolCallOutputScreenshot` - - A computer screenshot image used with the computer use tool. - - - `type: "computer_screenshot"` - - Specifies the event type. For a computer screenshot, this property is - always set to `computer_screenshot`. - - - `"computer_screenshot"` - - - `file_id: optional string` - - The identifier of an uploaded file that contains the screenshot. - - - `image_url: optional string` - - The URL of the screenshot image. - - - `status: "completed" or "incomplete" or "failed" or "in_progress"` - - The status of the message input. One of `in_progress`, `completed`, or - `incomplete`. Populated when input items are returned via API. - - - `"completed"` - - - `"incomplete"` - - - `"failed"` - - - `"in_progress"` - - - `type: "computer_call_output"` - - The type of the computer tool call output. Always `computer_call_output`. - - - `"computer_call_output"` - - - `acknowledged_safety_checks: optional array of object { id, code, message }` - - The safety checks reported by the API that have been acknowledged by the - developer. - - - `id: string` - - The ID of the pending safety check. - - - `code: optional string or null` - - The type of the pending safety check. - - - `message: optional string or null` - - Details about the pending safety check. - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `WebSearchCall object { id, action, status, type }` - - The results of a web search tool call. See the - [web search guide](/docs/guides/tools-web-search) for more information. - - - `id: string` - - The unique ID of the web search tool call. - - - `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }` - - An object describing the specific action taken in this web search call. - Includes details on how the model used the web (search, open_page, find_in_page). - - - `Search object { type, queries, query, sources }` - - Action type "search" - Performs a web search query. - - - `type: "search"` - - The action type. - - - `"search"` - - - `queries: optional array of string` - - The search queries. - - - `query: optional string` - - The search query. - - - `sources: optional array of object { type, url }` - - The sources used in the search. - - - `type: "url"` - - The type of source. Always `url`. - - - `"url"` - - - `url: string` - - The URL of the source. - - - `OpenPage object { type, url }` - - Action type "open_page" - Opens a specific URL from search results. - - - `type: "open_page"` - - The action type. - - - `"open_page"` - - - `url: optional string or null` - - The URL opened by the model. - - - `FindInPage object { pattern, type, url }` - - Action type "find_in_page": Searches for a pattern within a loaded page. - - - `pattern: string` - - The pattern or text to search for within the page. - - - `type: "find_in_page"` - - The action type. - - - `"find_in_page"` - - - `url: string` - - The URL of the page searched for the pattern. - - - `status: "in_progress" or "searching" or "completed" or "failed"` - - The status of the web search tool call. - - - `"in_progress"` - - - `"searching"` - - - `"completed"` - - - `"failed"` - - - `type: "web_search_call"` - - The type of the web search tool call. Always `web_search_call`. - - - `"web_search_call"` - - - `FunctionCall object { id, arguments, call_id, 6 more }` - - - `id: string` - - The unique ID of the function tool call. - - - `arguments: string` - - A JSON string of the arguments to pass to the function. - - - `call_id: string` - - The unique ID of the function tool call generated by the model. - - - `name: string` - - The name of the function to run. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "function_call"` - - The type of the function tool call. Always `function_call`. - - - `"function_call"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `namespace: optional string` - - The namespace of the function to run. - - - `FunctionCallOutput object { id, output, status, 6 more }` - - - `id: string` - - The unique ID of the function call tool output. - - - `output: string or array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - The output from the function call generated by your code. - Can be a string or an list of output content. - - - `StringOutput = string` - - A string of the output of the function call. - - - `OutputContentList = array of ResponseInputText or ResponseInputImage or ResponseInputFile` - - Text, image, or file output of the function call. - - - `ResponseInputText object { text, type, prompt_cache_breakpoint }` - - A text input to the model. - - - `ResponseInputImage object { detail, type, file_id, 2 more }` - - An image input to the model. Learn about [image inputs](/docs/guides/vision). - - - `ResponseInputFile object { type, detail, file_data, 4 more }` - - A file input to the model. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "function_call_output"` - - The type of the function tool call output. Always `function_call_output`. - - - `"function_call_output"` - - - `call_id: optional string` - - The unique ID of the function tool call generated by the model. - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - The caller type. Always `direct`. - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - The caller type. Always `program`. - - - `"program"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `name: optional string` - - The name of the tool that produced the output. - - - `namespace: optional string` - - The namespace of the tool that produced the output. - - - `ToolSearchCall object { id, arguments, call_id, 4 more }` - - - `id: string` - - The unique ID of the tool search call item. - - - `arguments: unknown` - - Arguments used for the tool search call. - - - `call_id: string or null` - - The unique ID of the tool search call generated by the model. - - - `execution: "server" or "client"` - - Whether tool search was executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the tool search call item that was recorded. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "tool_search_call"` - - The type of the item. Always `tool_search_call`. - - - `"tool_search_call"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `ToolSearchOutput object { id, call_id, execution, 4 more }` - - - `id: string` - - The unique ID of the tool search output item. - - - `call_id: string or null` - - The unique ID of the tool search call generated by the model. - - - `execution: "server" or "client"` - - Whether tool search was executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the tool search output item that was recorded. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more` - - The loaded tool definitions returned by tool search. - - - `Function object { name, parameters, strict, 5 more }` - - 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). - - - `name: string` - - The name of the function to call. - - - `parameters: map[unknown] or null` - - A JSON schema object describing the parameters of the function. - - - `strict: boolean or null` - - Whether strict parameter validation is enforced for this function tool. - - - `type: "function"` - - The type of the function tool. Always `function`. - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function is deferred and loaded via tool search. - - - `description: optional string or null` - - A description of the function. Used by the model to determine whether or not to call the function. - - - `output_schema: optional map[unknown] or null` - - A JSON schema object describing the JSON value encoded in string outputs for this function. - - - `FileSearch object { type, vector_store_ids, filters, 2 more }` - - 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). - - - `type: "file_search"` - - The type of the file search tool. Always `file_search`. - - - `"file_search"` - - - `vector_store_ids: array of string` - - The IDs of the vector stores to search. - - - `filters: optional ComparisonFilter or CompoundFilter or null` - - A filter to apply. - - - `ComparisonFilter object { key, type, value }` - - A filter used to compare a specified attribute key to a given value using a defined comparison operation. - - - `key: string` - - The key to compare against the value. - - - `type: "eq" or "ne" or "gt" or 5 more` - - Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`. - - - `eq`: equals - - `ne`: not equal - - `gt`: greater than - - `gte`: greater than or equal - - `lt`: less than - - `lte`: less than or equal - - `in`: in - - `nin`: not in - - - `"eq"` - - - `"ne"` - - - `"gt"` - - - `"gte"` - - - `"lt"` - - - `"lte"` - - - `"in"` - - - `"nin"` - - - `value: string or number or boolean or array of string or number` - - The value to compare against the attribute key; supports string, number, or boolean types. - - - `string` - - - `number` - - - `boolean` - - - `array of string or number` - - - `string` - - - `number` - - - `CompoundFilter object { filters, type }` - - Combine multiple filters using `and` or `or`. - - - `filters: array of ComparisonFilter or unknown` - - Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`. - - - `ComparisonFilter object { key, type, value }` - - A filter used to compare a specified attribute key to a given value using a defined comparison operation. - - - `unknown` - - - `type: "and" or "or"` - - Type of operation: `and` or `or`. - - - `"and"` - - - `"or"` - - - `max_num_results: optional number` - - The maximum number of results to return. This number should be between 1 and 50 inclusive. - - - `ranking_options: optional object { hybrid_search, ranker, score_threshold }` - - Ranking options for search. - - - `hybrid_search: optional object { embedding_weight, text_weight }` - - Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. - - - `embedding_weight: number` - - The weight of the embedding in the reciprocal ranking fusion. - - - `text_weight: number` - - The weight of the text in the reciprocal ranking fusion. - - - `ranker: optional "auto" or "default-2024-11-15"` - - The ranker to use for the file search. - - - `"auto"` - - - `"default-2024-11-15"` - - - `score_threshold: optional number` - - The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results. - - - `Computer object { type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `type: "computer"` - - The type of the computer tool. Always `computer`. - - - `"computer"` - - - `ComputerUsePreview object { display_height, display_width, environment, type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `display_height: number` - - The height of the computer display. - - - `display_width: number` - - The width of the computer display. - - - `environment: "windows" or "mac" or "linux" or 2 more` - - The type of computer environment to control. - - - `"windows"` - - - `"mac"` - - - `"linux"` - - - `"ubuntu"` - - - `"browser"` - - - `type: "computer_use_preview"` - - The type of the computer use tool. Always `computer_use_preview`. - - - `"computer_use_preview"` - - - `WebSearch object { type, filters, search_context_size, user_location }` - - Search the Internet for sources related to the prompt. Learn more about the - [web search tool](/docs/guides/tools-web-search). - - - `type: "web_search" or "web_search_2025_08_26"` - - The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - - - `"web_search"` - - - `"web_search_2025_08_26"` - - - `filters: optional object { allowed_domains } or null` - - Filters for the search. - - - `allowed_domains: optional array of string or null` - - Allowed domains for the search. If not provided, all domains are allowed. - Subdomains of the provided domains are allowed as well. - - Example: `["pubmed.ncbi.nlm.nih.gov"]` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { city, country, region, 2 more } or null` - - The approximate location of the user. - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `type: optional "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `Mcp object { server_label, type, allowed_callers, 9 more }` - - Give the model access to additional tools via remote Model Context Protocol - (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp). - - - `server_label: string` - - A label for this MCP server, used to identify it in tool calls. - - - `type: "mcp"` - - The type of the MCP tool. Always `mcp`. - - - `"mcp"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `allowed_tools: optional array of string or object { read_only, tool_names } or null` - - List of allowed tool names or a filter object. - - - `McpAllowedTools = array of string` - - A string array of allowed tool names - - - `McpToolFilter object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `authorization: optional string` - - An OAuth access token that can be used with a remote MCP server, either - with a custom MCP server URL or a service connector. Your application - must handle the OAuth authorization flow and provide the token here. - - - `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more` - - 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](/docs/guides/tools-remote-mcp#connectors). - - Currently supported `connector_id` values are: - - - Dropbox: `connector_dropbox` - - Gmail: `connector_gmail` - - Google Calendar: `connector_googlecalendar` - - Google Drive: `connector_googledrive` - - Microsoft Teams: `connector_microsoftteams` - - Outlook Calendar: `connector_outlookcalendar` - - Outlook Email: `connector_outlookemail` - - SharePoint: `connector_sharepoint` - - - `"connector_dropbox"` - - - `"connector_gmail"` - - - `"connector_googlecalendar"` - - - `"connector_googledrive"` - - - `"connector_microsoftteams"` - - - `"connector_outlookcalendar"` - - - `"connector_outlookemail"` - - - `"connector_sharepoint"` - - - `defer_loading: optional boolean` - - Whether this MCP tool is deferred and discovered via tool search. - - - `headers: optional map[string] or null` - - Optional HTTP headers to send to the MCP server. Use for authentication - or other purposes. - - - `require_approval: optional object { always, never } or "always" or "never" or null` - - Specify which of the MCP server's tools require approval. - - - `McpToolApprovalFilter object { always, never }` - - Specify which of the MCP server's tools require approval. Can be - `always`, `never`, or a filter object associated with tools - that require approval. - - - `always: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `never: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `McpToolApprovalSetting = "always" or "never"` - - Specify a single approval policy for all tools. One of `always` or - `never`. When set to `always`, all tools will require approval. When - set to `never`, all tools will not require approval. - - - `"always"` - - - `"never"` - - - `server_description: optional string` - - Optional description of the MCP server, used to provide more context. - - - `server_url: optional string` - - The URL for the MCP server. One of `server_url`, `connector_id`, or - `tunnel_id` must be provided. - - - `tunnel_id: optional string` - - The Secure MCP Tunnel ID to use instead of a direct server URL. One of - `server_url`, `connector_id`, or `tunnel_id` must be provided. - - - `CodeInterpreter object { container, type, allowed_callers }` - - A tool that runs Python code to help generate a response to a prompt. - - - `container: string or object { type, file_ids, memory_limit, network_policy }` - - The code interpreter container. Can be a container ID or an object that - specifies uploaded file IDs to make available to your code, along with an - optional `memory_limit` setting. - - - `string` - - The container ID. - - - `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }` - - Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. - - - `type: "auto"` - - Always `auto`. - - - `"auto"` - - - `file_ids: optional array of string` - - An optional list of uploaded files to make available to your code. - - - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` - - The memory limit for the code interpreter container. - - - `"1g"` - - - `"4g"` - - - `"16g"` - - - `"64g"` - - - `network_policy: optional ContainerNetworkPolicyDisabled or ContainerNetworkPolicyAllowlist` - - Network access policy for the container. - - - `ContainerNetworkPolicyDisabled object { type }` - - - `type: "disabled"` - - Disable outbound network access. Always `disabled`. - - - `"disabled"` - - - `ContainerNetworkPolicyAllowlist object { allowed_domains, type, domain_secrets }` - - - `allowed_domains: array of string` - - A list of allowed domains when type is `allowlist`. - - - `type: "allowlist"` - - Allow outbound network access only to specified domains. Always `allowlist`. - - - `"allowlist"` - - - `domain_secrets: optional array of ContainerNetworkPolicyDomainSecret` - - Optional domain-scoped secrets for allowlisted domains. - - - `domain: string` - - The domain associated with the secret. - - - `name: string` - - The name of the secret to inject for the domain. - - - `value: string` - - The secret value to inject for the domain. - - - `type: "code_interpreter"` - - The type of the code interpreter tool. Always `code_interpreter`. - - - `"code_interpreter"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `ProgrammaticToolCalling object { type }` - - - `type: "programmatic_tool_calling"` - - The type of the tool. Always `programmatic_tool_calling`. - - - `"programmatic_tool_calling"` - - - `ImageGeneration object { type, action, background, 9 more }` - - A tool that generates images using the GPT image models. - - - `type: "image_generation"` - - The type of the image generation tool. Always `image_generation`. - - - `"image_generation"` - - - `action: optional "generate" or "edit" or "auto"` - - Whether to generate a new image or edit an existing image. Default: `auto`. - - - `"generate"` - - - `"edit"` - - - `"auto"` - - - `background: optional "transparent" or "opaque" or "auto"` - - Background type for the generated image. One of `transparent`, - `opaque`, or `auto`. Default: `auto`. - - - `"transparent"` - - - `"opaque"` - - - `"auto"` - - - `input_fidelity: optional "high" or "low" or null` - - 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`. - - - `"high"` - - - `"low"` - - - `input_image_mask: optional object { file_id, image_url }` - - Optional mask for inpainting. Contains `image_url` - (string, optional) and `file_id` (string, optional). - - - `file_id: optional string` - - File ID for the mask image. - - - `image_url: optional string` - - Base64-encoded mask image. - - - `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `string` - - - `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `"gpt-image-1"` - - - `"gpt-image-1-mini"` - - - `"gpt-image-1.5"` - - - `moderation: optional "auto" or "low"` - - Moderation level for the generated image. Default: `auto`. - - - `"auto"` - - - `"low"` - - - `output_compression: optional number` - - Compression level for the output image. Default: 100. - - - `output_format: optional "png" or "webp" or "jpeg"` - - The output format of the generated image. One of `png`, `webp`, or - `jpeg`. Default: `png`. - - - `"png"` - - - `"webp"` - - - `"jpeg"` - - - `partial_images: optional number` - - Number of partial images to generate in streaming mode, from 0 (default value) to 3. - - - `quality: optional "low" or "medium" or "high" or "auto"` - - The quality of the generated image. One of `low`, `medium`, `high`, - or `auto`. Default: `auto`. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `"auto"` - - - `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `string` - - - `"1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `"1024x1024"` - - - `"1024x1536"` - - - `"1536x1024"` - - - `"auto"` - - - `LocalShell object { type }` - - A tool that allows the model to execute shell commands in a local environment. - - - `type: "local_shell"` - - The type of the local shell tool. Always `local_shell`. - - - `"local_shell"` - - - `Shell object { type, allowed_callers, environment }` - - A tool that allows the model to execute shell commands. - - - `type: "shell"` - - The type of the shell tool. Always `shell`. - - - `"shell"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - - - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` - - - `type: "container_auto"` - - Automatically creates a container for this request - - - `"container_auto"` - - - `file_ids: optional array of string` - - An optional list of uploaded files to make available to your code. - - - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` - - The memory limit for the container. - - - `"1g"` - - - `"4g"` - - - `"16g"` - - - `"64g"` - - - `network_policy: optional ContainerNetworkPolicyDisabled or ContainerNetworkPolicyAllowlist` - - Network access policy for the container. - - - `ContainerNetworkPolicyDisabled object { type }` - - - `ContainerNetworkPolicyAllowlist object { allowed_domains, type, domain_secrets }` - - - `skills: optional array of SkillReference or InlineSkill` - - An optional list of skills referenced by id or inline data. - - - `SkillReference object { skill_id, type, version }` - - - `skill_id: string` - - The ID of the referenced skill. - - - `type: "skill_reference"` - - References a skill created with the /v1/skills endpoint. - - - `"skill_reference"` - - - `version: optional string` - - Optional skill version. Use a positive integer or 'latest'. Omit for default. - - - `InlineSkill object { description, name, source, type }` - - - `description: string` - - The description of the skill. - - - `name: string` - - The name of the skill. - - - `source: InlineSkillSource` - - Inline skill payload - - - `data: string` - - Base64-encoded skill zip bundle. - - - `media_type: "application/zip"` - - The media type of the inline skill payload. Must be `application/zip`. - - - `"application/zip"` - - - `type: "base64"` - - The type of the inline skill source. Must be `base64`. - - - `"base64"` - - - `type: "inline"` - - Defines an inline skill for this request. - - - `"inline"` - - - `LocalEnvironment object { type, skills }` - - - `type: "local"` - - Use a local computer environment. - - - `"local"` - - - `skills: optional array of LocalSkill` - - An optional list of skills. - - - `description: string` - - The description of the skill. - - - `name: string` - - The name of the skill. - - - `path: string` - - The path to the directory containing the skill. - - - `ContainerReference object { container_id, type }` - - - `container_id: string` - - The ID of the referenced container. - - - `type: "container_reference"` - - References a container created with the /v1/containers endpoint - - - `"container_reference"` - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `Text object { type }` - - Unconstrained free-form text. - - - `type: "text"` - - Unconstrained text format. Always `text`. - - - `"text"` - - - `Grammar object { definition, syntax, type }` - - A grammar defined by the user. - - - `definition: string` - - The grammar definition. - - - `syntax: "lark" or "regex"` - - The syntax of the grammar definition. One of `lark` or `regex`. - - - `"lark"` - - - `"regex"` - - - `type: "grammar"` - - Grammar format. Always `grammar`. - - - `"grammar"` - - - `Namespace object { description, name, tools, type }` - - Groups function/custom tools under a shared namespace. - - - `description: string` - - A description of the namespace shown to the model. - - - `name: string` - - The namespace name used in tool calls (for example, `crm`). - - - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }` - - The function/custom tools available inside this namespace. - - - `Function object { name, type, allowed_callers, 5 more }` - - - `name: string` - - - `type: "function"` - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function should be deferred and discovered via tool search. - - - `description: optional string or null` - - - `output_schema: optional map[unknown] or null` - - A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs. - - - `parameters: optional unknown or null` - - - `strict: optional boolean or null` - - Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise. - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `type: "namespace"` - - The type of the tool. Always `namespace`. - - - `"namespace"` - - - `ToolSearch object { type, description, execution, parameters }` - - Hosted or BYOT tool search configuration for deferred tools. - - - `type: "tool_search"` - - The type of the tool. Always `tool_search`. - - - `"tool_search"` - - - `description: optional string or null` - - Description shown to the model for a client-executed tool search tool. - - - `execution: optional "server" or "client"` - - Whether tool search is executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `parameters: optional unknown or null` - - Parameter schema for a client-executed tool search tool. - - - `WebSearchPreview object { type, search_content_types, search_context_size, user_location }` - - 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). - - - `type: "web_search_preview" or "web_search_preview_2025_03_11"` - - The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. - - - `"web_search_preview"` - - - `"web_search_preview_2025_03_11"` - - - `search_content_types: optional array of "text" or "image"` - - - `"text"` - - - `"image"` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { type, city, country, 2 more } or null` - - The user's location. - - - `type: "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `ApplyPatch object { type, allowed_callers }` - - Allows the assistant to create, delete, or update files using unified diffs. - - - `type: "apply_patch"` - - The type of the tool. Always `apply_patch`. - - - `"apply_patch"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `type: "tool_search_output"` - - The type of the item. Always `tool_search_output`. - - - `"tool_search_output"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `AdditionalTools object { id, role, tools, type }` - - - `id: string` - - The unique ID of the additional tools item. - - - `role: "unknown" or "user" or "assistant" or 5 more` - - The role that provided the additional tools. - - - `"unknown"` - - - `"user"` - - - `"assistant"` - - - `"system"` - - - `"critic"` - - - `"discriminator"` - - - `"developer"` - - - `"tool"` - - - `tools: array of object { name, parameters, strict, 5 more } or object { type, vector_store_ids, filters, 2 more } or object { type } or 13 more` - - The additional tool definitions made available at this item. - - - `Function object { name, parameters, strict, 5 more }` - - 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). - - - `name: string` - - The name of the function to call. - - - `parameters: map[unknown] or null` - - A JSON schema object describing the parameters of the function. - - - `strict: boolean or null` - - Whether strict parameter validation is enforced for this function tool. - - - `type: "function"` - - The type of the function tool. Always `function`. - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function is deferred and loaded via tool search. - - - `description: optional string or null` - - A description of the function. Used by the model to determine whether or not to call the function. - - - `output_schema: optional map[unknown] or null` - - A JSON schema object describing the JSON value encoded in string outputs for this function. - - - `FileSearch object { type, vector_store_ids, filters, 2 more }` - - 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). - - - `type: "file_search"` - - The type of the file search tool. Always `file_search`. - - - `"file_search"` - - - `vector_store_ids: array of string` - - The IDs of the vector stores to search. - - - `filters: optional ComparisonFilter or CompoundFilter or null` - - A filter to apply. - - - `ComparisonFilter object { key, type, value }` - - A filter used to compare a specified attribute key to a given value using a defined comparison operation. - - - `CompoundFilter object { filters, type }` - - Combine multiple filters using `and` or `or`. - - - `max_num_results: optional number` - - The maximum number of results to return. This number should be between 1 and 50 inclusive. - - - `ranking_options: optional object { hybrid_search, ranker, score_threshold }` - - Ranking options for search. - - - `hybrid_search: optional object { embedding_weight, text_weight }` - - Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. - - - `embedding_weight: number` - - The weight of the embedding in the reciprocal ranking fusion. - - - `text_weight: number` - - The weight of the text in the reciprocal ranking fusion. - - - `ranker: optional "auto" or "default-2024-11-15"` - - The ranker to use for the file search. - - - `"auto"` - - - `"default-2024-11-15"` - - - `score_threshold: optional number` - - The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results. - - - `Computer object { type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `type: "computer"` - - The type of the computer tool. Always `computer`. - - - `"computer"` - - - `ComputerUsePreview object { display_height, display_width, environment, type }` - - A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). - - - `display_height: number` - - The height of the computer display. - - - `display_width: number` - - The width of the computer display. - - - `environment: "windows" or "mac" or "linux" or 2 more` - - The type of computer environment to control. - - - `"windows"` - - - `"mac"` - - - `"linux"` - - - `"ubuntu"` - - - `"browser"` - - - `type: "computer_use_preview"` - - The type of the computer use tool. Always `computer_use_preview`. - - - `"computer_use_preview"` - - - `WebSearch object { type, filters, search_context_size, user_location }` - - Search the Internet for sources related to the prompt. Learn more about the - [web search tool](/docs/guides/tools-web-search). - - - `type: "web_search" or "web_search_2025_08_26"` - - The type of the web search tool. One of `web_search` or `web_search_2025_08_26`. - - - `"web_search"` - - - `"web_search_2025_08_26"` - - - `filters: optional object { allowed_domains } or null` - - Filters for the search. - - - `allowed_domains: optional array of string or null` - - Allowed domains for the search. If not provided, all domains are allowed. - Subdomains of the provided domains are allowed as well. - - Example: `["pubmed.ncbi.nlm.nih.gov"]` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { city, country, region, 2 more } or null` - - The approximate location of the user. - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `type: optional "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `Mcp object { server_label, type, allowed_callers, 9 more }` - - Give the model access to additional tools via remote Model Context Protocol - (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp). - - - `server_label: string` - - A label for this MCP server, used to identify it in tool calls. - - - `type: "mcp"` - - The type of the MCP tool. Always `mcp`. - - - `"mcp"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `allowed_tools: optional array of string or object { read_only, tool_names } or null` - - List of allowed tool names or a filter object. - - - `McpAllowedTools = array of string` - - A string array of allowed tool names - - - `McpToolFilter object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `authorization: optional string` - - An OAuth access token that can be used with a remote MCP server, either - with a custom MCP server URL or a service connector. Your application - must handle the OAuth authorization flow and provide the token here. - - - `connector_id: optional "connector_dropbox" or "connector_gmail" or "connector_googlecalendar" or 5 more` - - 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](/docs/guides/tools-remote-mcp#connectors). - - Currently supported `connector_id` values are: - - - Dropbox: `connector_dropbox` - - Gmail: `connector_gmail` - - Google Calendar: `connector_googlecalendar` - - Google Drive: `connector_googledrive` - - Microsoft Teams: `connector_microsoftteams` - - Outlook Calendar: `connector_outlookcalendar` - - Outlook Email: `connector_outlookemail` - - SharePoint: `connector_sharepoint` - - - `"connector_dropbox"` - - - `"connector_gmail"` - - - `"connector_googlecalendar"` - - - `"connector_googledrive"` - - - `"connector_microsoftteams"` - - - `"connector_outlookcalendar"` - - - `"connector_outlookemail"` - - - `"connector_sharepoint"` - - - `defer_loading: optional boolean` - - Whether this MCP tool is deferred and discovered via tool search. - - - `headers: optional map[string] or null` - - Optional HTTP headers to send to the MCP server. Use for authentication - or other purposes. - - - `require_approval: optional object { always, never } or "always" or "never" or null` - - Specify which of the MCP server's tools require approval. - - - `McpToolApprovalFilter object { always, never }` - - Specify which of the MCP server's tools require approval. Can be - `always`, `never`, or a filter object associated with tools - that require approval. - - - `always: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `never: optional object { read_only, tool_names }` - - A filter object to specify which tools are allowed. - - - `read_only: optional boolean` - - Indicates whether or not a tool modifies data or is read-only. If an - MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint), - it will match this filter. - - - `tool_names: optional array of string` - - List of allowed tool names. - - - `McpToolApprovalSetting = "always" or "never"` - - Specify a single approval policy for all tools. One of `always` or - `never`. When set to `always`, all tools will require approval. When - set to `never`, all tools will not require approval. - - - `"always"` - - - `"never"` - - - `server_description: optional string` - - Optional description of the MCP server, used to provide more context. - - - `server_url: optional string` - - The URL for the MCP server. One of `server_url`, `connector_id`, or - `tunnel_id` must be provided. - - - `tunnel_id: optional string` - - The Secure MCP Tunnel ID to use instead of a direct server URL. One of - `server_url`, `connector_id`, or `tunnel_id` must be provided. - - - `CodeInterpreter object { container, type, allowed_callers }` - - A tool that runs Python code to help generate a response to a prompt. - - - `container: string or object { type, file_ids, memory_limit, network_policy }` - - The code interpreter container. Can be a container ID or an object that - specifies uploaded file IDs to make available to your code, along with an - optional `memory_limit` setting. - - - `string` - - The container ID. - - - `CodeInterpreterToolAuto object { type, file_ids, memory_limit, network_policy }` - - Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. - - - `type: "auto"` - - Always `auto`. - - - `"auto"` - - - `file_ids: optional array of string` - - An optional list of uploaded files to make available to your code. - - - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` - - The memory limit for the code interpreter container. - - - `"1g"` - - - `"4g"` - - - `"16g"` - - - `"64g"` - - - `network_policy: optional ContainerNetworkPolicyDisabled or ContainerNetworkPolicyAllowlist` - - Network access policy for the container. - - - `ContainerNetworkPolicyDisabled object { type }` - - - `ContainerNetworkPolicyAllowlist object { allowed_domains, type, domain_secrets }` - - - `type: "code_interpreter"` - - The type of the code interpreter tool. Always `code_interpreter`. - - - `"code_interpreter"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `ProgrammaticToolCalling object { type }` - - - `type: "programmatic_tool_calling"` - - The type of the tool. Always `programmatic_tool_calling`. - - - `"programmatic_tool_calling"` - - - `ImageGeneration object { type, action, background, 9 more }` - - A tool that generates images using the GPT image models. - - - `type: "image_generation"` - - The type of the image generation tool. Always `image_generation`. - - - `"image_generation"` - - - `action: optional "generate" or "edit" or "auto"` - - Whether to generate a new image or edit an existing image. Default: `auto`. - - - `"generate"` - - - `"edit"` - - - `"auto"` - - - `background: optional "transparent" or "opaque" or "auto"` - - Background type for the generated image. One of `transparent`, - `opaque`, or `auto`. Default: `auto`. - - - `"transparent"` - - - `"opaque"` - - - `"auto"` - - - `input_fidelity: optional "high" or "low" or null` - - 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`. - - - `"high"` - - - `"low"` - - - `input_image_mask: optional object { file_id, image_url }` - - Optional mask for inpainting. Contains `image_url` - (string, optional) and `file_id` (string, optional). - - - `file_id: optional string` - - File ID for the mask image. - - - `image_url: optional string` - - Base64-encoded mask image. - - - `model: optional string or "gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `string` - - - `"gpt-image-1" or "gpt-image-1-mini" or "gpt-image-1.5"` - - The image generation model to use. Default: `gpt-image-1`. - - - `"gpt-image-1"` - - - `"gpt-image-1-mini"` - - - `"gpt-image-1.5"` - - - `moderation: optional "auto" or "low"` - - Moderation level for the generated image. Default: `auto`. - - - `"auto"` - - - `"low"` - - - `output_compression: optional number` - - Compression level for the output image. Default: 100. - - - `output_format: optional "png" or "webp" or "jpeg"` - - The output format of the generated image. One of `png`, `webp`, or - `jpeg`. Default: `png`. - - - `"png"` - - - `"webp"` - - - `"jpeg"` - - - `partial_images: optional number` - - Number of partial images to generate in streaming mode, from 0 (default value) to 3. - - - `quality: optional "low" or "medium" or "high" or "auto"` - - The quality of the generated image. One of `low`, `medium`, `high`, - or `auto`. Default: `auto`. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `"auto"` - - - `size: optional string or "1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `string` - - - `"1024x1024" or "1024x1536" or "1536x1024" or "auto"` - - The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`. - - - `"1024x1024"` - - - `"1024x1536"` - - - `"1536x1024"` - - - `"auto"` - - - `LocalShell object { type }` - - A tool that allows the model to execute shell commands in a local environment. - - - `type: "local_shell"` - - The type of the local shell tool. Always `local_shell`. - - - `"local_shell"` - - - `Shell object { type, allowed_callers, environment }` - - A tool that allows the model to execute shell commands. - - - `type: "shell"` - - The type of the shell tool. Always `shell`. - - - `"shell"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - - - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` - - - `LocalEnvironment object { type, skills }` - - - `ContainerReference object { container_id, type }` - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `Namespace object { description, name, tools, type }` - - Groups function/custom tools under a shared namespace. - - - `description: string` - - A description of the namespace shown to the model. - - - `name: string` - - The namespace name used in tool calls (for example, `crm`). - - - `tools: array of object { name, type, allowed_callers, 5 more } or object { name, type, allowed_callers, 3 more }` - - The function/custom tools available inside this namespace. - - - `Function object { name, type, allowed_callers, 5 more }` - - - `name: string` - - - `type: "function"` - - - `"function"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this function should be deferred and discovered via tool search. - - - `description: optional string or null` - - - `output_schema: optional map[unknown] or null` - - A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs. - - - `parameters: optional unknown or null` - - - `strict: optional boolean or null` - - Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise. - - - `Custom object { name, type, allowed_callers, 3 more }` - - A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools) - - - `name: string` - - The name of the custom tool, used to identify it in tool calls. - - - `type: "custom"` - - The type of the custom tool. Always `custom`. - - - `"custom"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `defer_loading: optional boolean` - - Whether this tool should be deferred and discovered via tool search. - - - `description: optional string` - - Optional description of the custom tool, used to provide more context. - - - `format: optional CustomToolInputFormat` - - The input format for the custom tool. Default is unconstrained text. - - - `type: "namespace"` - - The type of the tool. Always `namespace`. - - - `"namespace"` - - - `ToolSearch object { type, description, execution, parameters }` - - Hosted or BYOT tool search configuration for deferred tools. - - - `type: "tool_search"` - - The type of the tool. Always `tool_search`. - - - `"tool_search"` - - - `description: optional string or null` - - Description shown to the model for a client-executed tool search tool. - - - `execution: optional "server" or "client"` - - Whether tool search is executed by the server or by the client. - - - `"server"` - - - `"client"` - - - `parameters: optional unknown or null` - - Parameter schema for a client-executed tool search tool. - - - `WebSearchPreview object { type, search_content_types, search_context_size, user_location }` - - 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). - - - `type: "web_search_preview" or "web_search_preview_2025_03_11"` - - The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`. - - - `"web_search_preview"` - - - `"web_search_preview_2025_03_11"` - - - `search_content_types: optional array of "text" or "image"` - - - `"text"` - - - `"image"` - - - `search_context_size: optional "low" or "medium" or "high"` - - High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default. - - - `"low"` - - - `"medium"` - - - `"high"` - - - `user_location: optional object { type, city, country, 2 more } or null` - - The user's location. - - - `type: "approximate"` - - The type of location approximation. Always `approximate`. - - - `"approximate"` - - - `city: optional string or null` - - Free text input for the city of the user, e.g. `San Francisco`. - - - `country: optional string or null` - - The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`. - - - `region: optional string or null` - - Free text input for the region of the user, e.g. `California`. - - - `timezone: optional string or null` - - The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. - - - `ApplyPatch object { type, allowed_callers }` - - Allows the assistant to create, delete, or update files using unified diffs. - - - `type: "apply_patch"` - - The type of the tool. Always `apply_patch`. - - - `"apply_patch"` - - - `allowed_callers: optional array of "direct" or "programmatic" or null` - - The tool invocation context(s). - - - `"direct"` - - - `"programmatic"` - - - `type: "additional_tools"` - - The type of the item. Always `additional_tools`. - - - `"additional_tools"` - - - `Reasoning object { id, summary, type, 3 more }` - - 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](/docs/guides/conversation-state). - - - `id: string` - - The unique identifier of the reasoning content. - - - `summary: array of SummaryTextContent` - - Reasoning summary content. - - - `text: string` - - A summary of the reasoning output from the model so far. - - - `type: "summary_text"` - - The type of the object. Always `summary_text`. - - - `"summary_text"` - - - `type: "reasoning"` - - The type of the object. Always `reasoning`. - - - `"reasoning"` - - - `content: optional array of object { text, type }` - - Reasoning text content. - - - `text: string` - - The reasoning text from the model. - - - `type: "reasoning_text"` - - The type of the reasoning text. Always `reasoning_text`. - - - `"reasoning_text"` - - - `encrypted_content: optional string or null` - - The encrypted content of the reasoning item. This is populated by default - for reasoning items returned by `POST /v1/responses` and WebSocket - `response.create` requests. - - - `status: optional "in_progress" or "completed" or "incomplete"` - - The status of the item. One of `in_progress`, `completed`, or - `incomplete`. Populated when items are returned via API. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `Program object { id, call_id, code, 2 more }` - - - `id: string` - - The unique ID of the program item. - - - `call_id: string` - - The stable call ID of the program item. - - - `code: string` - - The JavaScript source executed by programmatic tool calling. - - - `fingerprint: string` - - Opaque program replay fingerprint that must be round-tripped. - - - `type: "program"` - - The type of the item. Always `program`. - - - `"program"` - - - `ProgramOutput object { id, call_id, result, 2 more }` - - - `id: string` - - The unique ID of the program output item. - - - `call_id: string` - - The call ID of the program item. - - - `result: string` - - The result produced by the program item. - - - `status: "completed" or "incomplete"` - - The terminal status of the program output item. - - - `"completed"` - - - `"incomplete"` - - - `type: "program_output"` - - The type of the item. Always `program_output`. - - - `"program_output"` - - - `Compaction object { id, encrypted_content, type, created_by }` - - A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact). - - - `id: string` - - The unique ID of the compaction item. - - - `encrypted_content: string` - - The encrypted content that was produced by compaction. - - - `type: "compaction"` - - The type of the item. Always `compaction`. - - - `"compaction"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `ImageGenerationCall object { id, result, status, type }` - - An image generation request made by the model. - - - `id: string` - - The unique ID of the image generation call. - - - `result: string or null` - - The generated image encoded in base64. - - - `status: "in_progress" or "completed" or "generating" or "failed"` - - The status of the image generation call. - - - `"in_progress"` - - - `"completed"` - - - `"generating"` - - - `"failed"` - - - `type: "image_generation_call"` - - The type of the image generation call. Always `image_generation_call`. - - - `"image_generation_call"` - - - `CodeInterpreterCall object { id, code, container_id, 3 more }` - - A tool call to run code. - - - `id: string` - - The unique ID of the code interpreter tool call. - - - `code: string or null` - - The code to run, or null if not available. - - - `container_id: string` - - The ID of the container used to run the code. - - - `outputs: array of object { logs, type } or object { type, url } or null` - - The outputs generated by the code interpreter, such as logs or images. - Can be null if no outputs are available. - - - `Logs object { logs, type }` - - The logs output from the code interpreter. - - - `logs: string` - - The logs output from the code interpreter. - - - `type: "logs"` - - The type of the output. Always `logs`. - - - `"logs"` - - - `Image object { type, url }` - - The image output from the code interpreter. - - - `type: "image"` - - The type of the output. Always `image`. - - - `"image"` - - - `url: string` - - The URL of the image output from the code interpreter. - - - `status: "in_progress" or "completed" or "incomplete" or 2 more` - - The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `"interpreting"` - - - `"failed"` - - - `type: "code_interpreter_call"` - - The type of the code interpreter tool call. Always `code_interpreter_call`. - - - `"code_interpreter_call"` - - - `LocalShellCall object { id, action, call_id, 2 more }` - - A tool call to run a command on the local shell. - - - `id: string` - - The unique ID of the local shell call. - - - `action: object { command, env, type, 3 more }` - - Execute a shell command on the server. - - - `command: array of string` - - The command to run. - - - `env: map[string]` - - Environment variables to set for the command. - - - `type: "exec"` - - The type of the local shell action. Always `exec`. - - - `"exec"` - - - `timeout_ms: optional number or null` - - Optional timeout in milliseconds for the command. - - - `user: optional string or null` - - Optional user to run the command as. - - - `working_directory: optional string or null` - - Optional working directory to run the command in. - - - `call_id: string` - - The unique ID of the local shell tool call generated by the model. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the local shell call. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "local_shell_call"` - - The type of the local shell call. Always `local_shell_call`. - - - `"local_shell_call"` - - - `LocalShellCallOutput object { id, output, type, status }` - - The output of a local shell tool call. - - - `id: string` - - The unique ID of the local shell tool call generated by the model. - - - `output: string` - - A JSON string of the output of the local shell tool call. - - - `type: "local_shell_call_output"` - - The type of the local shell tool call output. Always `local_shell_call_output`. - - - `"local_shell_call_output"` - - - `status: optional "in_progress" or "completed" or "incomplete" or null` - - The status of the item. One of `in_progress`, `completed`, or `incomplete`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `ShellCall object { id, action, call_id, 5 more }` - - A tool call that executes one or more shell commands in a managed environment. - - - `id: string` - - The unique ID of the shell tool call. Populated when this item is returned via API. - - - `action: object { commands, max_output_length, timeout_ms }` - - The shell commands and limits that describe how to run the tool call. - - - `commands: array of string` - - - `max_output_length: number or null` - - Optional maximum number of characters to return from each command. - - - `timeout_ms: number or null` - - Optional timeout in milliseconds for the commands. - - - `call_id: string` - - The unique ID of the shell tool call generated by the model. - - - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` - - Represents the use of a local environment to perform shell actions. - - - `ResponseLocalEnvironment object { type }` - - Represents the use of a local environment to perform shell actions. - - - `type: "local"` - - The environment type. Always `local`. - - - `"local"` - - - `ResponseContainerReference object { container_id, type }` - - Represents a container created with /v1/containers. - - - `container_id: string` - - - `type: "container_reference"` - - The environment type. Always `container_reference`. - - - `"container_reference"` - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "shell_call"` - - The type of the item. Always `shell_call`. - - - `"shell_call"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The ID of the entity that created this tool call. - - - `ShellCallOutput object { id, call_id, max_output_length, 5 more }` - - The output of a shell tool call that was emitted. - - - `id: string` - - The unique ID of the shell call output. Populated when this item is returned via API. - - - `call_id: string` - - The unique ID of the shell tool call generated by the model. - - - `max_output_length: number or null` - - The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. - - - `output: array of object { outcome, stderr, stdout, created_by }` - - An array of shell call output contents - - - `outcome: object { type } or object { exit_code, type }` - - Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. - - - `Timeout object { type }` - - Indicates that the shell call exceeded its configured time limit. - - - `type: "timeout"` - - The outcome type. Always `timeout`. - - - `"timeout"` - - - `Exit object { exit_code, type }` - - Indicates that the shell commands finished and returned an exit code. - - - `exit_code: number` - - Exit code from the shell process. - - - `type: "exit"` - - The outcome type. Always `exit`. - - - `"exit"` - - - `stderr: string` - - The standard error output that was captured. - - - `stdout: string` - - The standard output that was captured. - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `status: "in_progress" or "completed" or "incomplete"` - - The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. - - - `"in_progress"` - - - `"completed"` - - - `"incomplete"` - - - `type: "shell_call_output"` - - The type of the shell call output. Always `shell_call_output`. - - - `"shell_call_output"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The identifier of the actor that created the item. - - - `ApplyPatchCall object { id, call_id, operation, 4 more }` - - A tool call that applies file diffs by creating, deleting, or updating files. - - - `id: string` - - The unique ID of the apply patch tool call. Populated when this item is returned via API. - - - `call_id: string` - - The unique ID of the apply patch tool call generated by the model. - - - `operation: object { diff, path, type } or object { path, type } or object { diff, path, type }` - - One of the create_file, delete_file, or update_file operations applied via apply_patch. - - - `CreateFile object { diff, path, type }` - - Instruction describing how to create a file via the apply_patch tool. - - - `diff: string` - - Diff to apply. - - - `path: string` - - Path of the file to create. - - - `type: "create_file"` - - Create a new file with the provided diff. - - - `"create_file"` - - - `DeleteFile object { path, type }` - - Instruction describing how to delete a file via the apply_patch tool. - - - `path: string` - - Path of the file to delete. - - - `type: "delete_file"` - - Delete the specified file. - - - `"delete_file"` - - - `UpdateFile object { diff, path, type }` - - Instruction describing how to update a file via the apply_patch tool. - - - `diff: string` - - Diff to apply. - - - `path: string` - - Path of the file to update. - - - `type: "update_file"` - - Update an existing file with the provided diff. - - - `"update_file"` - - - `status: "in_progress" or "completed"` - - The status of the apply patch tool call. One of `in_progress` or `completed`. - - - `"in_progress"` - - - `"completed"` - - - `type: "apply_patch_call"` - - The type of the item. Always `apply_patch_call`. - - - `"apply_patch_call"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The ID of the entity that created this tool call. - - - `ApplyPatchCallOutput object { id, call_id, status, 4 more }` - - The output emitted by an apply patch tool call. - - - `id: string` - - The unique ID of the apply patch tool call output. Populated when this item is returned via API. - - - `call_id: string` - - The unique ID of the apply patch tool call generated by the model. - - - `status: "completed" or "failed"` - - The status of the apply patch tool call output. One of `completed` or `failed`. - - - `"completed"` - - - `"failed"` - - - `type: "apply_patch_call_output"` - - The type of the item. Always `apply_patch_call_output`. - - - `"apply_patch_call_output"` - - - `caller: optional object { type } or object { caller_id, type } or null` - - The execution context that produced this tool call. - - - `Direct object { type }` - - - `type: "direct"` - - - `"direct"` - - - `Program object { caller_id, type }` - - - `caller_id: string` - - The call ID of the program item that produced this tool call. - - - `type: "program"` - - - `"program"` - - - `created_by: optional string` - - The ID of the entity that created this tool call output. - - - `output: optional string or null` - - Optional textual output returned by the apply patch tool. + Optional textual output returned by the apply patch tool. - `McpListTools object { id, server_label, tools, 2 more }` @@ -158613,7 +149060,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -158626,6 +149073,10 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -159644,7 +150095,7 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \ - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -159657,6 +150108,10 @@ curl https://api.openai.com/v1/responses/resp_abc123/input_items \ - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -162731,7 +153186,7 @@ Returns an object with `object` set to `response.input_tokens` and an `input_tok - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -162744,6 +153199,10 @@ Returns an object with `object` set to `response.input_tokens` and an `input_tok - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -163766,7 +154225,7 @@ Returns an object with `object` set to `response.input_tokens` and an `input_tok - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -163779,6 +154238,10 @@ Returns an object with `object` set to `response.input_tokens` and an `input_tok - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search. @@ -165907,7 +156370,7 @@ Returns an object with `object` set to `response.input_tokens` and an `input_tok - `"computer_use_preview"` - - `WebSearch object { type, filters, search_context_size, user_location }` + - `WebSearch object { type, external_web_access, filters, 2 more }` Search the Internet for sources related to the prompt. Learn more about the [web search tool](/docs/guides/tools-web-search). @@ -165920,6 +156383,10 @@ Returns an object with `object` set to `response.input_tokens` and an `input_tok - `"web_search_2025_08_26"` + - `external_web_access: optional boolean` + + Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content. + - `filters: optional object { allowed_domains } or null` Filters for the search.