diff --git a/en/resources/conversations/subresources/items/index.md b/en/resources/conversations/subresources/items/index.md index 5d5461a3..60b78a28 100644 --- a/en/resources/conversations/subresources/items/index.md +++ b/en/resources/conversations/subresources/items/index.md @@ -107,11 +107,11 @@ Create items in a conversation with the given ID. - `"input_image"` - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `image_url: optional string` + - `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. @@ -149,7 +149,7 @@ Create items in a conversation with the given ID. The content of the file to be sent to the model. - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. @@ -184,7 +184,7 @@ Create items in a conversation with the given ID. - `"developer"` - - `phase: optional "commentary" or "final_answer"` + - `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 @@ -417,7 +417,7 @@ Create items in a conversation with the given ID. - `"message"` - - `phase: optional "commentary" or "final_answer"` + - `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 @@ -461,11 +461,11 @@ Create items in a conversation with the given ID. - `"file_search_call"` - - `results: optional array of object { attributes, file_id, filename, 2 more }` + - `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]` + - `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 @@ -516,11 +516,11 @@ Create items in a conversation with the given ID. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -577,7 +577,7 @@ Create items in a conversation with the given ID. The y-coordinate where the click occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while clicking. @@ -585,7 +585,7 @@ Create items in a conversation with the given ID. A double click action. - - `keys: array of string` + - `keys: array of string or null` The keys being held while double-clicking. @@ -632,7 +632,7 @@ Create items in a conversation with the given ID. - `"drag"` - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while dragging the mouse. @@ -668,7 +668,7 @@ Create items in a conversation with the given ID. The y-coordinate to move to. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while moving the mouse. @@ -708,7 +708,7 @@ Create items in a conversation with the given ID. The y-coordinate where the scroll occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while scrolling. @@ -810,11 +810,11 @@ Create items in a conversation with the given ID. - `"computer_call_output"` - - `id: optional string` + - `id: optional string or null` The ID of the computer tool call output. - - `acknowledged_safety_checks: optional array of object { id, code, message }` + - `acknowledged_safety_checks: optional array of object { id, code, message } or null` The safety checks reported by the API that have been acknowledged by the developer. @@ -822,15 +822,15 @@ Create items in a conversation with the given ID. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. - - `status: optional "in_progress" or "completed" or "incomplete"` + - `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. @@ -896,7 +896,7 @@ Create items in a conversation with the given ID. - `"open_page"` - - `url: optional string` + - `url: optional string or null` The URL opened by the model. @@ -963,7 +963,7 @@ Create items in a conversation with the given ID. The unique ID of the function tool call. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -1032,7 +1032,7 @@ Create items in a conversation with the given ID. - `"input_text"` - - `prompt_cache_breakpoint: optional object { mode }` + - `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. @@ -1052,7 +1052,7 @@ Create items in a conversation with the given ID. - `"input_image"` - - `detail: optional "low" or "high" or "auto" or "original"` + - `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`. @@ -1064,15 +1064,15 @@ Create items in a conversation with the given ID. - `"original"` - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `image_url: optional string` + - `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 }` + - `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. @@ -1102,23 +1102,23 @@ Create items in a conversation with the given ID. - `"high"` - - `file_data: optional string` + - `file_data: optional string or null` The base64-encoded data of the file to be sent to the model. - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `file_url: optional string` + - `file_url: optional string or null` The URL of the file to be sent to the model. - - `filename: optional string` + - `filename: optional string or null` The name of the file to be sent to the model. - - `prompt_cache_breakpoint: optional object { mode }` + - `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. @@ -1134,11 +1134,11 @@ Create items in a conversation with the given ID. - `"function_call_output"` - - `id: optional string` + - `id: optional string or null` The unique ID of the function tool call output. Populated when this item is returned via API. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -1162,15 +1162,15 @@ Create items in a conversation with the given ID. - `"program"` - - `name: optional string` + - `name: optional string or null` The name of the tool that produced the output. - - `namespace: optional string` + - `namespace: optional string or null` The namespace of the tool that produced the output. - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. @@ -1192,11 +1192,11 @@ Create items in a conversation with the given ID. - `"tool_search_call"` - - `id: optional string` + - `id: optional string or null` The unique ID of this tool search call. - - `call_id: optional string` + - `call_id: optional string or null` The unique ID of the tool search call generated by the model. @@ -1208,7 +1208,7 @@ Create items in a conversation with the given ID. - `"client"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the tool search call. @@ -1232,11 +1232,11 @@ Create items in a conversation with the given ID. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -1246,7 +1246,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -1258,11 +1258,11 @@ Create items in a conversation with the given ID. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -1280,7 +1280,7 @@ Create items in a conversation with the given ID. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -1446,11 +1446,11 @@ Create items in a conversation with the given ID. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -1467,23 +1467,23 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -1508,7 +1508,7 @@ Create items in a conversation with the given ID. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -1516,7 +1516,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -1581,12 +1581,12 @@ Create items in a conversation with the given ID. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -1676,7 +1676,7 @@ Create items in a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -1734,7 +1734,7 @@ Create items in a conversation with the given ID. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -1781,7 +1781,7 @@ Create items in a conversation with the given ID. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -1896,7 +1896,7 @@ Create items in a conversation with the given ID. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -1904,7 +1904,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -1918,7 +1918,7 @@ Create items in a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the container. @@ -2044,7 +2044,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2120,7 +2120,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2132,15 +2132,15 @@ Create items in a conversation with the given ID. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -2158,7 +2158,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2194,7 +2194,7 @@ Create items in a conversation with the given ID. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -2206,7 +2206,7 @@ Create items in a conversation with the given ID. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -2238,7 +2238,7 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -2248,19 +2248,19 @@ Create items in a conversation with the given ID. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -2274,7 +2274,7 @@ Create items in a conversation with the given ID. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2288,11 +2288,11 @@ Create items in a conversation with the given ID. - `"tool_search_output"` - - `id: optional string` + - `id: optional string or null` The unique ID of this tool search output. - - `call_id: optional string` + - `call_id: optional string or null` The unique ID of the tool search call generated by the model. @@ -2304,7 +2304,7 @@ Create items in a conversation with the given ID. - `"client"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the tool search output. @@ -2334,11 +2334,11 @@ Create items in a conversation with the given ID. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -2348,7 +2348,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2360,11 +2360,11 @@ Create items in a conversation with the given ID. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -2382,7 +2382,7 @@ Create items in a conversation with the given ID. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -2481,11 +2481,11 @@ Create items in a conversation with the given ID. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -2502,23 +2502,23 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -2543,7 +2543,7 @@ Create items in a conversation with the given ID. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2551,7 +2551,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -2616,12 +2616,12 @@ Create items in a conversation with the given ID. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -2711,7 +2711,7 @@ Create items in a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -2737,7 +2737,7 @@ Create items in a conversation with the given ID. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2784,7 +2784,7 @@ Create items in a conversation with the given ID. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -2899,7 +2899,7 @@ Create items in a conversation with the given ID. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2907,7 +2907,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -2929,7 +2929,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2973,7 +2973,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2985,15 +2985,15 @@ Create items in a conversation with the given ID. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -3011,7 +3011,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -3047,7 +3047,7 @@ Create items in a conversation with the given ID. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -3059,7 +3059,7 @@ Create items in a conversation with the given ID. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -3091,7 +3091,7 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -3101,19 +3101,19 @@ Create items in a conversation with the given ID. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -3127,7 +3127,7 @@ Create items in a conversation with the given ID. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -3141,7 +3141,7 @@ Create items in a conversation with the given ID. - `"additional_tools"` - - `id: optional string` + - `id: optional string or null` The unique ID of this additional tools item. @@ -3190,7 +3190,7 @@ Create items in a conversation with the given ID. - `"reasoning_text"` - - `encrypted_content: optional string` + - `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 @@ -3221,7 +3221,7 @@ Create items in a conversation with the given ID. - `"compaction"` - - `id: optional string` + - `id: optional string or null` The ID of the compaction item. @@ -3233,7 +3233,7 @@ Create items in a conversation with the given ID. The unique ID of the image generation call. - - `result: string` + - `result: string or null` The generated image encoded in base64. @@ -3263,7 +3263,7 @@ Create items in a conversation with the given ID. The unique ID of the code interpreter tool call. - - `code: string` + - `code: string or null` The code to run, or null if not available. @@ -3271,7 +3271,7 @@ Create items in a conversation with the given ID. The ID of the container used to run the code. - - `outputs: array of object { logs, type } or object { type, url }` + - `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. @@ -3350,15 +3350,15 @@ Create items in a conversation with the given ID. - `"exec"` - - `timeout_ms: optional number` + - `timeout_ms: optional number or null` Optional timeout in milliseconds for the command. - - `user: optional string` + - `user: optional string or null` Optional user to run the command as. - - `working_directory: optional string` + - `working_directory: optional string or null` Optional working directory to run the command in. @@ -3400,7 +3400,7 @@ Create items in a conversation with the given ID. - `"local_shell_call_output"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the item. One of `in_progress`, `completed`, or `incomplete`. @@ -3422,11 +3422,11 @@ Create items in a conversation with the given ID. Ordered shell commands for the execution environment to run. - - `max_output_length: optional number` + - `max_output_length: optional number or null` Maximum number of UTF-8 characters to capture from combined stdout and stderr output. - - `timeout_ms: optional number` + - `timeout_ms: optional number or null` Maximum wall-clock time in milliseconds to allow the shell commands to run. @@ -3440,11 +3440,11 @@ Create items in a conversation with the given ID. - `"shell_call"` - - `id: optional string` + - `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 }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -3468,7 +3468,7 @@ Create items in a conversation with the given ID. - `"program"` - - `environment: optional LocalEnvironment or ContainerReference` + - `environment: optional LocalEnvironment or ContainerReference or null` The environment to execute the shell commands in. @@ -3476,7 +3476,7 @@ Create items in a conversation with the given ID. - `ContainerReference object { container_id, type }` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. @@ -3540,11 +3540,11 @@ Create items in a conversation with the given ID. - `"shell_call_output"` - - `id: optional string` + - `id: optional string or null` The unique ID of the shell tool call output. Populated when this item is returned via API. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -3568,11 +3568,11 @@ Create items in a conversation with the given ID. - `"program"` - - `max_output_length: optional number` + - `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"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the shell call output. @@ -3658,11 +3658,11 @@ Create items in a conversation with the given ID. - `"apply_patch_call"` - - `id: optional string` + - `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 }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -3708,11 +3708,11 @@ Create items in a conversation with the given ID. - `"apply_patch_call_output"` - - `id: optional string` + - `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 }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -3736,7 +3736,7 @@ Create items in a conversation with the given ID. - `"program"` - - `output: optional string` + - `output: optional string or null` Optional human-readable log text from the apply patch tool (e.g., patch results or errors). @@ -3764,11 +3764,11 @@ Create items in a conversation with the given ID. The name of the tool. - - `annotations: optional unknown` + - `annotations: optional unknown or null` Additional annotations about the tool. - - `description: optional string` + - `description: optional string or null` The description of the tool. @@ -3778,7 +3778,7 @@ Create items in a conversation with the given ID. - `"mcp_list_tools"` - - `error: optional string` + - `error: optional string or null` Error message if the server could not list tools. @@ -3826,11 +3826,11 @@ Create items in a conversation with the given ID. - `"mcp_approval_response"` - - `id: optional string` + - `id: optional string or null` The unique ID of the approval response - - `reason: optional string` + - `reason: optional string or null` Optional reason for the decision. @@ -3860,16 +3860,16 @@ Create items in a conversation with the given ID. - `"mcp_call"` - - `approval_request_id: optional string` + - `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` + - `error: optional string or null` The error from the tool call, if any. - - `output: optional string` + - `output: optional string or null` The output from the tool call. @@ -3930,7 +3930,7 @@ Create items in a conversation with the given ID. The unique ID of the custom tool call output in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -3980,7 +3980,7 @@ Create items in a conversation with the given ID. The unique ID of the custom tool call in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -4022,7 +4022,7 @@ Create items in a conversation with the given ID. The ID of the item to reference. - - `type: optional "item_reference"` + - `type: optional "item_reference" or null` The type of item to reference. Always `item_reference`. @@ -4330,11 +4330,11 @@ Create items in a conversation with the given ID. - `"input_image"` - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `image_url: optional string` + - `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. @@ -4364,11 +4364,11 @@ Create items in a conversation with the given ID. - `"original"` - - `file_id: string` + - `file_id: string or null` The identifier of an uploaded file that contains the screenshot. - - `image_url: string` + - `image_url: string or null` The URL of the screenshot image. @@ -4412,7 +4412,7 @@ Create items in a conversation with the given ID. The content of the file to be sent to the model. - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. @@ -4470,7 +4470,7 @@ Create items in a conversation with the given ID. - `"message"` - - `phase: optional "commentary" or "final_answer"` + - `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. @@ -4513,7 +4513,7 @@ Create items in a conversation with the given ID. - `"function_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -4593,7 +4593,7 @@ Create items in a conversation with the given ID. - `"function_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -4663,11 +4663,11 @@ Create items in a conversation with the given ID. - `"file_search_call"` - - `results: optional array of object { attributes, file_id, filename, 2 more }` + - `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]` + - `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 @@ -4753,7 +4753,7 @@ Create items in a conversation with the given ID. - `"open_page"` - - `url: optional string` + - `url: optional string or null` The URL opened by the model. @@ -4801,7 +4801,7 @@ Create items in a conversation with the given ID. The unique ID of the image generation call. - - `result: string` + - `result: string or null` The generated image encoded in base64. @@ -4844,11 +4844,11 @@ Create items in a conversation with the given ID. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -4905,7 +4905,7 @@ Create items in a conversation with the given ID. The y-coordinate where the click occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while clicking. @@ -4913,7 +4913,7 @@ Create items in a conversation with the given ID. A double click action. - - `keys: array of string` + - `keys: array of string or null` The keys being held while double-clicking. @@ -4960,7 +4960,7 @@ Create items in a conversation with the given ID. - `"drag"` - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while dragging the mouse. @@ -4996,7 +4996,7 @@ Create items in a conversation with the given ID. The y-coordinate to move to. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while moving the mouse. @@ -5036,7 +5036,7 @@ Create items in a conversation with the given ID. The y-coordinate where the scroll occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while scrolling. @@ -5162,11 +5162,11 @@ Create items in a conversation with the given ID. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -5184,7 +5184,7 @@ Create items in a conversation with the given ID. Arguments used for the tool search call. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -5222,7 +5222,7 @@ Create items in a conversation with the given ID. The unique ID of the tool search output item. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -5256,11 +5256,11 @@ Create items in a conversation with the given ID. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -5270,7 +5270,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -5282,11 +5282,11 @@ Create items in a conversation with the given ID. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -5304,7 +5304,7 @@ Create items in a conversation with the given ID. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -5470,11 +5470,11 @@ Create items in a conversation with the given ID. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -5491,23 +5491,23 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -5532,7 +5532,7 @@ Create items in a conversation with the given ID. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -5540,7 +5540,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -5605,12 +5605,12 @@ Create items in a conversation with the given ID. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -5700,7 +5700,7 @@ Create items in a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -5758,7 +5758,7 @@ Create items in a conversation with the given ID. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -5805,7 +5805,7 @@ Create items in a conversation with the given ID. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -5920,7 +5920,7 @@ Create items in a conversation with the given ID. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -5928,7 +5928,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -5942,7 +5942,7 @@ Create items in a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the container. @@ -6068,7 +6068,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6144,7 +6144,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6156,15 +6156,15 @@ Create items in a conversation with the given ID. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -6182,7 +6182,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6218,7 +6218,7 @@ Create items in a conversation with the given ID. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -6230,7 +6230,7 @@ Create items in a conversation with the given ID. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -6262,7 +6262,7 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -6272,19 +6272,19 @@ Create items in a conversation with the given ID. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -6298,7 +6298,7 @@ Create items in a conversation with the given ID. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6354,11 +6354,11 @@ Create items in a conversation with the given ID. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -6368,7 +6368,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6380,11 +6380,11 @@ Create items in a conversation with the given ID. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -6402,7 +6402,7 @@ Create items in a conversation with the given ID. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -6501,11 +6501,11 @@ Create items in a conversation with the given ID. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -6522,23 +6522,23 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -6563,7 +6563,7 @@ Create items in a conversation with the given ID. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6571,7 +6571,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -6636,12 +6636,12 @@ Create items in a conversation with the given ID. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -6731,7 +6731,7 @@ Create items in a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -6757,7 +6757,7 @@ Create items in a conversation with the given ID. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6804,7 +6804,7 @@ Create items in a conversation with the given ID. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -6919,7 +6919,7 @@ Create items in a conversation with the given ID. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6927,7 +6927,7 @@ Create items in a conversation with the given ID. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -6949,7 +6949,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -6993,7 +6993,7 @@ Create items in a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -7005,15 +7005,15 @@ Create items in a conversation with the given ID. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -7031,7 +7031,7 @@ Create items in a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -7067,7 +7067,7 @@ Create items in a conversation with the given ID. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -7079,7 +7079,7 @@ Create items in a conversation with the given ID. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -7111,7 +7111,7 @@ Create items in a conversation with the given ID. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -7121,19 +7121,19 @@ Create items in a conversation with the given ID. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -7147,7 +7147,7 @@ Create items in a conversation with the given ID. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -7204,7 +7204,7 @@ Create items in a conversation with the given ID. - `"reasoning_text"` - - `encrypted_content: optional string` + - `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 @@ -7303,7 +7303,7 @@ Create items in a conversation with the given ID. The unique ID of the code interpreter tool call. - - `code: string` + - `code: string or null` The code to run, or null if not available. @@ -7311,7 +7311,7 @@ Create items in a conversation with the given ID. The ID of the container used to run the code. - - `outputs: array of object { logs, type } or object { type, url }` + - `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. @@ -7390,15 +7390,15 @@ Create items in a conversation with the given ID. - `"exec"` - - `timeout_ms: optional number` + - `timeout_ms: optional number or null` Optional timeout in milliseconds for the command. - - `user: optional string` + - `user: optional string or null` Optional user to run the command as. - - `working_directory: optional string` + - `working_directory: optional string or null` Optional working directory to run the command in. @@ -7440,7 +7440,7 @@ Create items in a conversation with the given ID. - `"local_shell_call_output"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the item. One of `in_progress`, `completed`, or `incomplete`. @@ -7464,11 +7464,11 @@ Create items in a conversation with the given ID. - `commands: array of string` - - `max_output_length: number` + - `max_output_length: number or null` Optional maximum number of characters to return from each command. - - `timeout_ms: number` + - `timeout_ms: number or null` Optional timeout in milliseconds for the commands. @@ -7476,7 +7476,7 @@ Create items in a conversation with the given ID. The unique ID of the shell tool call generated by the model. - - `environment: ResponseLocalEnvironment or ResponseContainerReference` + - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` Represents the use of a local environment to perform shell actions. @@ -7518,7 +7518,7 @@ Create items in a conversation with the given ID. - `"shell_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -7554,7 +7554,7 @@ Create items in a conversation with the given ID. The unique ID of the shell tool call generated by the model. - - `max_output_length: number` + - `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. @@ -7618,7 +7618,7 @@ Create items in a conversation with the given ID. - `"shell_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -7722,7 +7722,7 @@ Create items in a conversation with the given ID. - `"apply_patch_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -7772,7 +7772,7 @@ Create items in a conversation with the given ID. - `"apply_patch_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -7796,7 +7796,7 @@ Create items in a conversation with the given ID. The ID of the entity that created this tool call output. - - `output: optional string` + - `output: optional string or null` Optional textual output returned by the apply patch tool. @@ -7824,11 +7824,11 @@ Create items in a conversation with the given ID. The name of the tool. - - `annotations: optional unknown` + - `annotations: optional unknown or null` Additional annotations about the tool. - - `description: optional string` + - `description: optional string or null` The description of the tool. @@ -7838,7 +7838,7 @@ Create items in a conversation with the given ID. - `"mcp_list_tools"` - - `error: optional string` + - `error: optional string or null` Error message if the server could not list tools. @@ -7890,7 +7890,7 @@ Create items in a conversation with the given ID. - `"mcp_approval_response"` - - `reason: optional string` + - `reason: optional string or null` Optional reason for the decision. @@ -7920,16 +7920,16 @@ Create items in a conversation with the given ID. - `"mcp_call"` - - `approval_request_id: optional string` + - `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` + - `error: optional string or null` The error from the tool call, if any. - - `output: optional string` + - `output: optional string or null` The output from the tool call. @@ -7973,7 +7973,7 @@ Create items in a conversation with the given ID. The unique ID of the custom tool call in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -8040,7 +8040,7 @@ Create items in a conversation with the given ID. The unique ID of the custom tool call output in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -8567,11 +8567,11 @@ List all items for a conversation with the given ID. - `"input_image"` - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `image_url: optional string` + - `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. @@ -8601,11 +8601,11 @@ List all items for a conversation with the given ID. - `"original"` - - `file_id: string` + - `file_id: string or null` The identifier of an uploaded file that contains the screenshot. - - `image_url: string` + - `image_url: string or null` The URL of the screenshot image. @@ -8649,7 +8649,7 @@ List all items for a conversation with the given ID. The content of the file to be sent to the model. - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. @@ -8707,7 +8707,7 @@ List all items for a conversation with the given ID. - `"message"` - - `phase: optional "commentary" or "final_answer"` + - `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. @@ -8750,7 +8750,7 @@ List all items for a conversation with the given ID. - `"function_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -8830,7 +8830,7 @@ List all items for a conversation with the given ID. - `"function_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -8900,11 +8900,11 @@ List all items for a conversation with the given ID. - `"file_search_call"` - - `results: optional array of object { attributes, file_id, filename, 2 more }` + - `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]` + - `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 @@ -8990,7 +8990,7 @@ List all items for a conversation with the given ID. - `"open_page"` - - `url: optional string` + - `url: optional string or null` The URL opened by the model. @@ -9038,7 +9038,7 @@ List all items for a conversation with the given ID. The unique ID of the image generation call. - - `result: string` + - `result: string or null` The generated image encoded in base64. @@ -9081,11 +9081,11 @@ List all items for a conversation with the given ID. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -9142,7 +9142,7 @@ List all items for a conversation with the given ID. The y-coordinate where the click occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while clicking. @@ -9150,7 +9150,7 @@ List all items for a conversation with the given ID. A double click action. - - `keys: array of string` + - `keys: array of string or null` The keys being held while double-clicking. @@ -9197,7 +9197,7 @@ List all items for a conversation with the given ID. - `"drag"` - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while dragging the mouse. @@ -9233,7 +9233,7 @@ List all items for a conversation with the given ID. The y-coordinate to move to. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while moving the mouse. @@ -9273,7 +9273,7 @@ List all items for a conversation with the given ID. The y-coordinate where the scroll occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while scrolling. @@ -9399,11 +9399,11 @@ List all items for a conversation with the given ID. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -9421,7 +9421,7 @@ List all items for a conversation with the given ID. Arguments used for the tool search call. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -9459,7 +9459,7 @@ List all items for a conversation with the given ID. The unique ID of the tool search output item. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -9493,11 +9493,11 @@ List all items for a conversation with the given ID. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -9507,7 +9507,7 @@ List all items for a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -9519,11 +9519,11 @@ List all items for a conversation with the given ID. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -9541,7 +9541,7 @@ List all items for a conversation with the given ID. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -9707,11 +9707,11 @@ List all items for a conversation with the given ID. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -9728,23 +9728,23 @@ List all items for a conversation with the given ID. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -9769,7 +9769,7 @@ List all items for a conversation with the given ID. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -9777,7 +9777,7 @@ List all items for a conversation with the given ID. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -9842,12 +9842,12 @@ List all items for a conversation with the given ID. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -9937,7 +9937,7 @@ List all items for a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -9995,7 +9995,7 @@ List all items for a conversation with the given ID. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10042,7 +10042,7 @@ List all items for a conversation with the given ID. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -10157,7 +10157,7 @@ List all items for a conversation with the given ID. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10165,7 +10165,7 @@ List all items for a conversation with the given ID. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -10179,7 +10179,7 @@ List all items for a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the container. @@ -10305,7 +10305,7 @@ List all items for a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10381,7 +10381,7 @@ List all items for a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10393,15 +10393,15 @@ List all items for a conversation with the given ID. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -10419,7 +10419,7 @@ List all items for a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10455,7 +10455,7 @@ List all items for a conversation with the given ID. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -10467,7 +10467,7 @@ List all items for a conversation with the given ID. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -10499,7 +10499,7 @@ List all items for a conversation with the given ID. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -10509,19 +10509,19 @@ List all items for a conversation with the given ID. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -10535,7 +10535,7 @@ List all items for a conversation with the given ID. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10591,11 +10591,11 @@ List all items for a conversation with the given ID. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -10605,7 +10605,7 @@ List all items for a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10617,11 +10617,11 @@ List all items for a conversation with the given ID. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -10639,7 +10639,7 @@ List all items for a conversation with the given ID. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -10738,11 +10738,11 @@ List all items for a conversation with the given ID. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -10759,23 +10759,23 @@ List all items for a conversation with the given ID. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -10800,7 +10800,7 @@ List all items for a conversation with the given ID. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -10808,7 +10808,7 @@ List all items for a conversation with the given ID. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -10873,12 +10873,12 @@ List all items for a conversation with the given ID. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -10968,7 +10968,7 @@ List all items for a conversation with the given ID. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -10994,7 +10994,7 @@ List all items for a conversation with the given ID. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -11041,7 +11041,7 @@ List all items for a conversation with the given ID. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -11156,7 +11156,7 @@ List all items for a conversation with the given ID. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -11164,7 +11164,7 @@ List all items for a conversation with the given ID. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -11186,7 +11186,7 @@ List all items for a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -11230,7 +11230,7 @@ List all items for a conversation with the given ID. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -11242,15 +11242,15 @@ List all items for a conversation with the given ID. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -11268,7 +11268,7 @@ List all items for a conversation with the given ID. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -11304,7 +11304,7 @@ List all items for a conversation with the given ID. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -11316,7 +11316,7 @@ List all items for a conversation with the given ID. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -11348,7 +11348,7 @@ List all items for a conversation with the given ID. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -11358,19 +11358,19 @@ List all items for a conversation with the given ID. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -11384,7 +11384,7 @@ List all items for a conversation with the given ID. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -11441,7 +11441,7 @@ List all items for a conversation with the given ID. - `"reasoning_text"` - - `encrypted_content: optional string` + - `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 @@ -11540,7 +11540,7 @@ List all items for a conversation with the given ID. The unique ID of the code interpreter tool call. - - `code: string` + - `code: string or null` The code to run, or null if not available. @@ -11548,7 +11548,7 @@ List all items for a conversation with the given ID. The ID of the container used to run the code. - - `outputs: array of object { logs, type } or object { type, url }` + - `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. @@ -11627,15 +11627,15 @@ List all items for a conversation with the given ID. - `"exec"` - - `timeout_ms: optional number` + - `timeout_ms: optional number or null` Optional timeout in milliseconds for the command. - - `user: optional string` + - `user: optional string or null` Optional user to run the command as. - - `working_directory: optional string` + - `working_directory: optional string or null` Optional working directory to run the command in. @@ -11677,7 +11677,7 @@ List all items for a conversation with the given ID. - `"local_shell_call_output"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the item. One of `in_progress`, `completed`, or `incomplete`. @@ -11701,11 +11701,11 @@ List all items for a conversation with the given ID. - `commands: array of string` - - `max_output_length: number` + - `max_output_length: number or null` Optional maximum number of characters to return from each command. - - `timeout_ms: number` + - `timeout_ms: number or null` Optional timeout in milliseconds for the commands. @@ -11713,7 +11713,7 @@ List all items for a conversation with the given ID. The unique ID of the shell tool call generated by the model. - - `environment: ResponseLocalEnvironment or ResponseContainerReference` + - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` Represents the use of a local environment to perform shell actions. @@ -11755,7 +11755,7 @@ List all items for a conversation with the given ID. - `"shell_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -11791,7 +11791,7 @@ List all items for a conversation with the given ID. The unique ID of the shell tool call generated by the model. - - `max_output_length: number` + - `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. @@ -11855,7 +11855,7 @@ List all items for a conversation with the given ID. - `"shell_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -11959,7 +11959,7 @@ List all items for a conversation with the given ID. - `"apply_patch_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -12009,7 +12009,7 @@ List all items for a conversation with the given ID. - `"apply_patch_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -12033,7 +12033,7 @@ List all items for a conversation with the given ID. The ID of the entity that created this tool call output. - - `output: optional string` + - `output: optional string or null` Optional textual output returned by the apply patch tool. @@ -12061,11 +12061,11 @@ List all items for a conversation with the given ID. The name of the tool. - - `annotations: optional unknown` + - `annotations: optional unknown or null` Additional annotations about the tool. - - `description: optional string` + - `description: optional string or null` The description of the tool. @@ -12075,7 +12075,7 @@ List all items for a conversation with the given ID. - `"mcp_list_tools"` - - `error: optional string` + - `error: optional string or null` Error message if the server could not list tools. @@ -12127,7 +12127,7 @@ List all items for a conversation with the given ID. - `"mcp_approval_response"` - - `reason: optional string` + - `reason: optional string or null` Optional reason for the decision. @@ -12157,16 +12157,16 @@ List all items for a conversation with the given ID. - `"mcp_call"` - - `approval_request_id: optional string` + - `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` + - `error: optional string or null` The error from the tool call, if any. - - `output: optional string` + - `output: optional string or null` The output from the tool call. @@ -12210,7 +12210,7 @@ List all items for a conversation with the given ID. The unique ID of the custom tool call in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -12277,7 +12277,7 @@ List all items for a conversation with the given ID. The unique ID of the custom tool call output in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -12665,11 +12665,11 @@ Get a single item from a conversation with the given IDs. - `"input_image"` - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `image_url: optional string` + - `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. @@ -12699,11 +12699,11 @@ Get a single item from a conversation with the given IDs. - `"original"` - - `file_id: string` + - `file_id: string or null` The identifier of an uploaded file that contains the screenshot. - - `image_url: string` + - `image_url: string or null` The URL of the screenshot image. @@ -12747,7 +12747,7 @@ Get a single item from a conversation with the given IDs. The content of the file to be sent to the model. - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. @@ -12805,7 +12805,7 @@ Get a single item from a conversation with the given IDs. - `"message"` - - `phase: optional "commentary" or "final_answer"` + - `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. @@ -12848,7 +12848,7 @@ Get a single item from a conversation with the given IDs. - `"function_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -12928,7 +12928,7 @@ Get a single item from a conversation with the given IDs. - `"function_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -12998,11 +12998,11 @@ Get a single item from a conversation with the given IDs. - `"file_search_call"` - - `results: optional array of object { attributes, file_id, filename, 2 more }` + - `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]` + - `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 @@ -13088,7 +13088,7 @@ Get a single item from a conversation with the given IDs. - `"open_page"` - - `url: optional string` + - `url: optional string or null` The URL opened by the model. @@ -13136,7 +13136,7 @@ Get a single item from a conversation with the given IDs. The unique ID of the image generation call. - - `result: string` + - `result: string or null` The generated image encoded in base64. @@ -13179,11 +13179,11 @@ Get a single item from a conversation with the given IDs. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -13240,7 +13240,7 @@ Get a single item from a conversation with the given IDs. The y-coordinate where the click occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while clicking. @@ -13248,7 +13248,7 @@ Get a single item from a conversation with the given IDs. A double click action. - - `keys: array of string` + - `keys: array of string or null` The keys being held while double-clicking. @@ -13295,7 +13295,7 @@ Get a single item from a conversation with the given IDs. - `"drag"` - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while dragging the mouse. @@ -13331,7 +13331,7 @@ Get a single item from a conversation with the given IDs. The y-coordinate to move to. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while moving the mouse. @@ -13371,7 +13371,7 @@ Get a single item from a conversation with the given IDs. The y-coordinate where the scroll occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while scrolling. @@ -13497,11 +13497,11 @@ Get a single item from a conversation with the given IDs. The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -13519,7 +13519,7 @@ Get a single item from a conversation with the given IDs. Arguments used for the tool search call. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -13557,7 +13557,7 @@ Get a single item from a conversation with the given IDs. The unique ID of the tool search output item. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -13591,11 +13591,11 @@ Get a single item from a conversation with the given IDs. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -13605,7 +13605,7 @@ Get a single item from a conversation with the given IDs. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -13617,11 +13617,11 @@ Get a single item from a conversation with the given IDs. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -13639,7 +13639,7 @@ Get a single item from a conversation with the given IDs. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -13805,11 +13805,11 @@ Get a single item from a conversation with the given IDs. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -13826,23 +13826,23 @@ Get a single item from a conversation with the given IDs. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -13867,7 +13867,7 @@ Get a single item from a conversation with the given IDs. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -13875,7 +13875,7 @@ Get a single item from a conversation with the given IDs. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -13940,12 +13940,12 @@ Get a single item from a conversation with the given IDs. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -14035,7 +14035,7 @@ Get a single item from a conversation with the given IDs. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -14093,7 +14093,7 @@ Get a single item from a conversation with the given IDs. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14140,7 +14140,7 @@ Get a single item from a conversation with the given IDs. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -14255,7 +14255,7 @@ Get a single item from a conversation with the given IDs. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14263,7 +14263,7 @@ Get a single item from a conversation with the given IDs. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -14277,7 +14277,7 @@ Get a single item from a conversation with the given IDs. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the container. @@ -14403,7 +14403,7 @@ Get a single item from a conversation with the given IDs. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14479,7 +14479,7 @@ Get a single item from a conversation with the given IDs. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14491,15 +14491,15 @@ Get a single item from a conversation with the given IDs. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -14517,7 +14517,7 @@ Get a single item from a conversation with the given IDs. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14553,7 +14553,7 @@ Get a single item from a conversation with the given IDs. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -14565,7 +14565,7 @@ Get a single item from a conversation with the given IDs. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -14597,7 +14597,7 @@ Get a single item from a conversation with the given IDs. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -14607,19 +14607,19 @@ Get a single item from a conversation with the given IDs. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -14633,7 +14633,7 @@ Get a single item from a conversation with the given IDs. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14689,11 +14689,11 @@ Get a single item from a conversation with the given IDs. The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -14703,7 +14703,7 @@ Get a single item from a conversation with the given IDs. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14715,11 +14715,11 @@ Get a single item from a conversation with the given IDs. Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -14737,7 +14737,7 @@ Get a single item from a conversation with the given IDs. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -14836,11 +14836,11 @@ Get a single item from a conversation with the given IDs. - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -14857,23 +14857,23 @@ Get a single item from a conversation with the given IDs. - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -14898,7 +14898,7 @@ Get a single item from a conversation with the given IDs. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -14906,7 +14906,7 @@ Get a single item from a conversation with the given IDs. - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -14971,12 +14971,12 @@ Get a single item from a conversation with the given IDs. Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -15066,7 +15066,7 @@ Get a single item from a conversation with the given IDs. An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -15092,7 +15092,7 @@ Get a single item from a conversation with the given IDs. - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -15139,7 +15139,7 @@ Get a single item from a conversation with the given IDs. - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -15254,7 +15254,7 @@ Get a single item from a conversation with the given IDs. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -15262,7 +15262,7 @@ Get a single item from a conversation with the given IDs. - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -15284,7 +15284,7 @@ Get a single item from a conversation with the given IDs. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -15328,7 +15328,7 @@ Get a single item from a conversation with the given IDs. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -15340,15 +15340,15 @@ Get a single item from a conversation with the given IDs. Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -15366,7 +15366,7 @@ Get a single item from a conversation with the given IDs. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -15402,7 +15402,7 @@ Get a single item from a conversation with the given IDs. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -15414,7 +15414,7 @@ Get a single item from a conversation with the given IDs. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -15446,7 +15446,7 @@ Get a single item from a conversation with the given IDs. - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -15456,19 +15456,19 @@ Get a single item from a conversation with the given IDs. - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -15482,7 +15482,7 @@ Get a single item from a conversation with the given IDs. - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -15539,7 +15539,7 @@ Get a single item from a conversation with the given IDs. - `"reasoning_text"` - - `encrypted_content: optional string` + - `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 @@ -15638,7 +15638,7 @@ Get a single item from a conversation with the given IDs. The unique ID of the code interpreter tool call. - - `code: string` + - `code: string or null` The code to run, or null if not available. @@ -15646,7 +15646,7 @@ Get a single item from a conversation with the given IDs. The ID of the container used to run the code. - - `outputs: array of object { logs, type } or object { type, url }` + - `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. @@ -15725,15 +15725,15 @@ Get a single item from a conversation with the given IDs. - `"exec"` - - `timeout_ms: optional number` + - `timeout_ms: optional number or null` Optional timeout in milliseconds for the command. - - `user: optional string` + - `user: optional string or null` Optional user to run the command as. - - `working_directory: optional string` + - `working_directory: optional string or null` Optional working directory to run the command in. @@ -15775,7 +15775,7 @@ Get a single item from a conversation with the given IDs. - `"local_shell_call_output"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the item. One of `in_progress`, `completed`, or `incomplete`. @@ -15799,11 +15799,11 @@ Get a single item from a conversation with the given IDs. - `commands: array of string` - - `max_output_length: number` + - `max_output_length: number or null` Optional maximum number of characters to return from each command. - - `timeout_ms: number` + - `timeout_ms: number or null` Optional timeout in milliseconds for the commands. @@ -15811,7 +15811,7 @@ Get a single item from a conversation with the given IDs. The unique ID of the shell tool call generated by the model. - - `environment: ResponseLocalEnvironment or ResponseContainerReference` + - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` Represents the use of a local environment to perform shell actions. @@ -15853,7 +15853,7 @@ Get a single item from a conversation with the given IDs. - `"shell_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -15889,7 +15889,7 @@ Get a single item from a conversation with the given IDs. The unique ID of the shell tool call generated by the model. - - `max_output_length: number` + - `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. @@ -15953,7 +15953,7 @@ Get a single item from a conversation with the given IDs. - `"shell_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -16057,7 +16057,7 @@ Get a single item from a conversation with the given IDs. - `"apply_patch_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -16107,7 +16107,7 @@ Get a single item from a conversation with the given IDs. - `"apply_patch_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -16131,7 +16131,7 @@ Get a single item from a conversation with the given IDs. The ID of the entity that created this tool call output. - - `output: optional string` + - `output: optional string or null` Optional textual output returned by the apply patch tool. @@ -16159,11 +16159,11 @@ Get a single item from a conversation with the given IDs. The name of the tool. - - `annotations: optional unknown` + - `annotations: optional unknown or null` Additional annotations about the tool. - - `description: optional string` + - `description: optional string or null` The description of the tool. @@ -16173,7 +16173,7 @@ Get a single item from a conversation with the given IDs. - `"mcp_list_tools"` - - `error: optional string` + - `error: optional string or null` Error message if the server could not list tools. @@ -16225,7 +16225,7 @@ Get a single item from a conversation with the given IDs. - `"mcp_approval_response"` - - `reason: optional string` + - `reason: optional string or null` Optional reason for the decision. @@ -16255,16 +16255,16 @@ Get a single item from a conversation with the given IDs. - `"mcp_call"` - - `approval_request_id: optional string` + - `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` + - `error: optional string or null` The error from the tool call, if any. - - `output: optional string` + - `output: optional string or null` The output from the tool call. @@ -16308,7 +16308,7 @@ Get a single item from a conversation with the given IDs. The unique ID of the custom tool call in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -16375,7 +16375,7 @@ Get a single item from a conversation with the given IDs. The unique ID of the custom tool call output in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -16696,11 +16696,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"input_image"` - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `image_url: optional string` + - `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. @@ -16730,11 +16730,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"original"` - - `file_id: string` + - `file_id: string or null` The identifier of an uploaded file that contains the screenshot. - - `image_url: string` + - `image_url: string or null` The URL of the screenshot image. @@ -16778,7 +16778,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The content of the file to be sent to the model. - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. @@ -16836,7 +16836,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"message"` - - `phase: optional "commentary" or "final_answer"` + - `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. @@ -16879,7 +16879,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -16959,7 +16959,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -17029,11 +17029,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"file_search_call"` - - `results: optional array of object { attributes, file_id, filename, 2 more }` + - `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]` + - `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 @@ -17119,7 +17119,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"open_page"` - - `url: optional string` + - `url: optional string or null` The URL opened by the model. @@ -17167,7 +17167,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the image generation call. - - `result: string` + - `result: string or null` The generated image encoded in base64. @@ -17210,11 +17210,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -17271,7 +17271,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The y-coordinate where the click occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while clicking. @@ -17279,7 +17279,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ A double click action. - - `keys: array of string` + - `keys: array of string or null` The keys being held while double-clicking. @@ -17326,7 +17326,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"drag"` - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while dragging the mouse. @@ -17362,7 +17362,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The y-coordinate to move to. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while moving the mouse. @@ -17402,7 +17402,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The y-coordinate where the scroll occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while scrolling. @@ -17528,11 +17528,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -17550,7 +17550,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Arguments used for the tool search call. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -17588,7 +17588,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the tool search output item. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -17622,11 +17622,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -17636,7 +17636,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -17648,11 +17648,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -17670,7 +17670,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -17836,11 +17836,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -17857,23 +17857,23 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -17898,7 +17898,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -17906,7 +17906,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -17971,12 +17971,12 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -18066,7 +18066,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -18124,7 +18124,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18171,7 +18171,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -18286,7 +18286,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18294,7 +18294,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -18308,7 +18308,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the container. @@ -18434,7 +18434,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18510,7 +18510,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18522,15 +18522,15 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -18548,7 +18548,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18584,7 +18584,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -18596,7 +18596,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -18628,7 +18628,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -18638,19 +18638,19 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -18664,7 +18664,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18720,11 +18720,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -18734,7 +18734,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18746,11 +18746,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -18768,7 +18768,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -18867,11 +18867,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -18888,23 +18888,23 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -18929,7 +18929,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -18937,7 +18937,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -19002,12 +19002,12 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -19097,7 +19097,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -19123,7 +19123,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -19170,7 +19170,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -19285,7 +19285,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -19293,7 +19293,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -19315,7 +19315,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -19359,7 +19359,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -19371,15 +19371,15 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -19397,7 +19397,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -19433,7 +19433,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -19445,7 +19445,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -19477,7 +19477,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -19487,19 +19487,19 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -19513,7 +19513,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -19570,7 +19570,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"reasoning_text"` - - `encrypted_content: optional string` + - `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 @@ -19669,7 +19669,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the code interpreter tool call. - - `code: string` + - `code: string or null` The code to run, or null if not available. @@ -19677,7 +19677,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the container used to run the code. - - `outputs: array of object { logs, type } or object { type, url }` + - `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. @@ -19756,15 +19756,15 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"exec"` - - `timeout_ms: optional number` + - `timeout_ms: optional number or null` Optional timeout in milliseconds for the command. - - `user: optional string` + - `user: optional string or null` Optional user to run the command as. - - `working_directory: optional string` + - `working_directory: optional string or null` Optional working directory to run the command in. @@ -19806,7 +19806,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"local_shell_call_output"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the item. One of `in_progress`, `completed`, or `incomplete`. @@ -19830,11 +19830,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `commands: array of string` - - `max_output_length: number` + - `max_output_length: number or null` Optional maximum number of characters to return from each command. - - `timeout_ms: number` + - `timeout_ms: number or null` Optional timeout in milliseconds for the commands. @@ -19842,7 +19842,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the shell tool call generated by the model. - - `environment: ResponseLocalEnvironment or ResponseContainerReference` + - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` Represents the use of a local environment to perform shell actions. @@ -19884,7 +19884,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -19920,7 +19920,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the shell tool call generated by the model. - - `max_output_length: number` + - `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. @@ -19984,7 +19984,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -20088,7 +20088,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -20138,7 +20138,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -20162,7 +20162,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the entity that created this tool call output. - - `output: optional string` + - `output: optional string or null` Optional textual output returned by the apply patch tool. @@ -20190,11 +20190,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The name of the tool. - - `annotations: optional unknown` + - `annotations: optional unknown or null` Additional annotations about the tool. - - `description: optional string` + - `description: optional string or null` The description of the tool. @@ -20204,7 +20204,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp_list_tools"` - - `error: optional string` + - `error: optional string or null` Error message if the server could not list tools. @@ -20256,7 +20256,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp_approval_response"` - - `reason: optional string` + - `reason: optional string or null` Optional reason for the decision. @@ -20286,16 +20286,16 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp_call"` - - `approval_request_id: optional string` + - `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` + - `error: optional string or null` The error from the tool call, if any. - - `output: optional string` + - `output: optional string or null` The output from the tool call. @@ -20339,7 +20339,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the custom tool call in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -20406,7 +20406,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the custom tool call output in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -20680,11 +20680,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"input_image"` - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. - - `image_url: optional string` + - `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. @@ -20714,11 +20714,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"original"` - - `file_id: string` + - `file_id: string or null` The identifier of an uploaded file that contains the screenshot. - - `image_url: string` + - `image_url: string or null` The URL of the screenshot image. @@ -20762,7 +20762,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The content of the file to be sent to the model. - - `file_id: optional string` + - `file_id: optional string or null` The ID of the file to be sent to the model. @@ -20820,7 +20820,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"message"` - - `phase: optional "commentary" or "final_answer"` + - `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. @@ -20863,7 +20863,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -20943,7 +20943,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -21013,11 +21013,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"file_search_call"` - - `results: optional array of object { attributes, file_id, filename, 2 more }` + - `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]` + - `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 @@ -21103,7 +21103,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"open_page"` - - `url: optional string` + - `url: optional string or null` The URL opened by the model. @@ -21151,7 +21151,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the image generation call. - - `result: string` + - `result: string or null` The generated image encoded in base64. @@ -21194,11 +21194,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -21255,7 +21255,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The y-coordinate where the click occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while clicking. @@ -21263,7 +21263,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ A double click action. - - `keys: array of string` + - `keys: array of string or null` The keys being held while double-clicking. @@ -21310,7 +21310,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"drag"` - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while dragging the mouse. @@ -21346,7 +21346,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The y-coordinate to move to. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while moving the mouse. @@ -21386,7 +21386,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The y-coordinate where the scroll occurred. - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while scrolling. @@ -21512,11 +21512,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the pending safety check. - - `code: optional string` + - `code: optional string or null` The type of the pending safety check. - - `message: optional string` + - `message: optional string or null` Details about the pending safety check. @@ -21534,7 +21534,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Arguments used for the tool search call. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -21572,7 +21572,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the tool search output item. - - `call_id: string` + - `call_id: string or null` The unique ID of the tool search call generated by the model. @@ -21606,11 +21606,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -21620,7 +21620,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -21632,11 +21632,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -21654,7 +21654,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -21820,11 +21820,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -21841,23 +21841,23 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -21882,7 +21882,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -21890,7 +21890,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -21955,12 +21955,12 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -22050,7 +22050,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -22108,7 +22108,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22155,7 +22155,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -22270,7 +22270,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22278,7 +22278,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -22292,7 +22292,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the container. @@ -22418,7 +22418,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22494,7 +22494,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22506,15 +22506,15 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -22532,7 +22532,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22568,7 +22568,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -22580,7 +22580,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -22612,7 +22612,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -22622,19 +22622,19 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -22648,7 +22648,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22704,11 +22704,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The name of the function to call. - - `parameters: map[unknown]` + - `parameters: map[unknown] or null` A JSON schema object describing the parameters of the function. - - `strict: boolean` + - `strict: boolean or null` Whether strict parameter validation is enforced for this function tool. @@ -22718,7 +22718,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22730,11 +22730,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function is deferred and loaded via tool search. - - `description: optional string` + - `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]` + - `output_schema: optional map[unknown] or null` A JSON schema object describing the JSON value encoded in string outputs for this function. @@ -22752,7 +22752,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -22851,11 +22851,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"web_search_2025_08_26"` - - `filters: optional object { allowed_domains }` + - `filters: optional object { allowed_domains } or null` Filters for the search. - - `allowed_domains: optional array of string` + - `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. @@ -22872,23 +22872,23 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { city, country, region, 2 more }` + - `user_location: optional object { city, country, region, 2 more } or null` The approximate location of the user. - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -22913,7 +22913,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -22921,7 +22921,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `allowed_tools: optional array of string or object { read_only, tool_names }` + - `allowed_tools: optional array of string or object { read_only, tool_names } or null` List of allowed tool names or a filter object. @@ -22986,12 +22986,12 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this MCP tool is deferred and discovered via tool search. - - `headers: optional map[string]` + - `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"` + - `require_approval: optional object { always, never } or "always" or "never" or null` Specify which of the MCP server's tools require approval. @@ -23081,7 +23081,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ An optional list of uploaded files to make available to your code. - - `memory_limit: optional "1g" or "4g" or "16g" or "64g"` + - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null` The memory limit for the code interpreter container. @@ -23107,7 +23107,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"code_interpreter"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -23154,7 +23154,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"auto"` - - `input_fidelity: optional "high" or "low"` + - `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`. @@ -23269,7 +23269,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -23277,7 +23277,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"programmatic"` - - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference` + - `environment: optional ContainerAuto or LocalEnvironment or ContainerReference or null` - `ContainerAuto object { type, file_ids, memory_limit, 2 more }` @@ -23299,7 +23299,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -23343,7 +23343,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -23355,15 +23355,15 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ Whether this function should be deferred and discovered via tool search. - - `description: optional string` + - `description: optional string or null` - - `output_schema: optional map[unknown]` + - `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` + - `parameters: optional unknown or null` - - `strict: optional boolean` + - `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. @@ -23381,7 +23381,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -23417,7 +23417,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -23429,7 +23429,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -23461,7 +23461,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"high"` - - `user_location: optional object { type, city, country, 2 more }` + - `user_location: optional object { type, city, country, 2 more } or null` The user's location. @@ -23471,19 +23471,19 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"approximate"` - - `city: optional string` + - `city: optional string or null` Free text input for the city of the user, e.g. `San Francisco`. - - `country: optional string` + - `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` + - `region: optional string or null` Free text input for the region of the user, e.g. `California`. - - `timezone: optional string` + - `timezone: optional string or null` The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`. @@ -23497,7 +23497,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -23554,7 +23554,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"reasoning_text"` - - `encrypted_content: optional string` + - `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 @@ -23653,7 +23653,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the code interpreter tool call. - - `code: string` + - `code: string or null` The code to run, or null if not available. @@ -23661,7 +23661,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the container used to run the code. - - `outputs: array of object { logs, type } or object { type, url }` + - `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. @@ -23740,15 +23740,15 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"exec"` - - `timeout_ms: optional number` + - `timeout_ms: optional number or null` Optional timeout in milliseconds for the command. - - `user: optional string` + - `user: optional string or null` Optional user to run the command as. - - `working_directory: optional string` + - `working_directory: optional string or null` Optional working directory to run the command in. @@ -23790,7 +23790,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"local_shell_call_output"` - - `status: optional "in_progress" or "completed" or "incomplete"` + - `status: optional "in_progress" or "completed" or "incomplete" or null` The status of the item. One of `in_progress`, `completed`, or `incomplete`. @@ -23814,11 +23814,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `commands: array of string` - - `max_output_length: number` + - `max_output_length: number or null` Optional maximum number of characters to return from each command. - - `timeout_ms: number` + - `timeout_ms: number or null` Optional timeout in milliseconds for the commands. @@ -23826,7 +23826,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the shell tool call generated by the model. - - `environment: ResponseLocalEnvironment or ResponseContainerReference` + - `environment: ResponseLocalEnvironment or ResponseContainerReference or null` Represents the use of a local environment to perform shell actions. @@ -23868,7 +23868,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -23904,7 +23904,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the shell tool call generated by the model. - - `max_output_length: number` + - `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. @@ -23968,7 +23968,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"shell_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -24072,7 +24072,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch_call"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -24122,7 +24122,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"apply_patch_call_output"` - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -24146,7 +24146,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The ID of the entity that created this tool call output. - - `output: optional string` + - `output: optional string or null` Optional textual output returned by the apply patch tool. @@ -24174,11 +24174,11 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The name of the tool. - - `annotations: optional unknown` + - `annotations: optional unknown or null` Additional annotations about the tool. - - `description: optional string` + - `description: optional string or null` The description of the tool. @@ -24188,7 +24188,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp_list_tools"` - - `error: optional string` + - `error: optional string or null` Error message if the server could not list tools. @@ -24240,7 +24240,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp_approval_response"` - - `reason: optional string` + - `reason: optional string or null` Optional reason for the decision. @@ -24270,16 +24270,16 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ - `"mcp_call"` - - `approval_request_id: optional string` + - `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` + - `error: optional string or null` The error from the tool call, if any. - - `output: optional string` + - `output: optional string or null` The output from the tool call. @@ -24323,7 +24323,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the custom tool call in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call. @@ -24390,7 +24390,7 @@ curl https://api.openai.com/v1/conversations/conv_123/items/msg_abc \ The unique ID of the custom tool call output in the OpenAI platform. - - `caller: optional object { type } or object { caller_id, type }` + - `caller: optional object { type } or object { caller_id, type } or null` The execution context that produced this tool call.