diff --git a/en/resources/conversations/index.md b/en/resources/conversations/index.md index d476b371..b66b28f2 100644 --- a/en/resources/conversations/index.md +++ b/en/resources/conversations/index.md @@ -8,7 +8,7 @@ Create a conversation. ### Body Parameters -- `items: optional array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more` +- `items: optional array of EasyInputMessage or object { content, role, status, type } or ResponseOutputMessage or 29 more or null` Initial items to include in the conversation context. You may add up to 20 items at a time. @@ -80,11 +80,11 @@ Create a conversation. - `"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. @@ -122,7 +122,7 @@ Create a conversation. 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. @@ -157,7 +157,7 @@ Create a conversation. - `"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 @@ -390,7 +390,7 @@ Create a conversation. - `"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 @@ -434,11 +434,11 @@ Create a conversation. - `"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 @@ -489,11 +489,11 @@ Create a conversation. 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. @@ -550,7 +550,7 @@ Create a conversation. 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. @@ -558,7 +558,7 @@ Create a conversation. A double click action. - - `keys: array of string` + - `keys: array of string or null` The keys being held while double-clicking. @@ -605,7 +605,7 @@ Create a conversation. - `"drag"` - - `keys: optional array of string` + - `keys: optional array of string or null` The keys being held while dragging the mouse. @@ -641,7 +641,7 @@ Create a conversation. 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. @@ -681,7 +681,7 @@ Create a conversation. 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. @@ -783,11 +783,11 @@ Create a conversation. - `"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. @@ -795,15 +795,15 @@ Create a conversation. 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. @@ -869,7 +869,7 @@ Create a conversation. - `"open_page"` - - `url: optional string` + - `url: optional string or null` The URL opened by the model. @@ -936,7 +936,7 @@ Create a conversation. 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. @@ -1005,7 +1005,7 @@ Create a conversation. - `"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. @@ -1025,7 +1025,7 @@ Create a conversation. - `"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`. @@ -1037,15 +1037,15 @@ Create a conversation. - `"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. @@ -1075,23 +1075,23 @@ Create a conversation. - `"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. @@ -1107,11 +1107,11 @@ Create a conversation. - `"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. @@ -1135,15 +1135,15 @@ Create a conversation. - `"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. @@ -1165,11 +1165,11 @@ Create a conversation. - `"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. @@ -1181,7 +1181,7 @@ Create a conversation. - `"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. @@ -1205,11 +1205,11 @@ Create a conversation. 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. @@ -1219,7 +1219,7 @@ Create a conversation. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -1231,11 +1231,11 @@ Create a conversation. 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. @@ -1253,7 +1253,7 @@ Create a conversation. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -1419,11 +1419,11 @@ Create a conversation. - `"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. @@ -1440,23 +1440,23 @@ Create a conversation. - `"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`. @@ -1481,7 +1481,7 @@ Create a conversation. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -1489,7 +1489,7 @@ Create a conversation. - `"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. @@ -1554,12 +1554,12 @@ Create a conversation. 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. @@ -1649,7 +1649,7 @@ Create a conversation. 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. @@ -1707,7 +1707,7 @@ Create a conversation. - `"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). @@ -1754,7 +1754,7 @@ Create a conversation. - `"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`. @@ -1869,7 +1869,7 @@ Create a conversation. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -1877,7 +1877,7 @@ Create a conversation. - `"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 }` @@ -1891,7 +1891,7 @@ Create a conversation. 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. @@ -2017,7 +2017,7 @@ Create a conversation. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2093,7 +2093,7 @@ Create a conversation. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2105,15 +2105,15 @@ Create a conversation. 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. @@ -2131,7 +2131,7 @@ Create a conversation. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2167,7 +2167,7 @@ Create a conversation. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -2179,7 +2179,7 @@ Create a conversation. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -2211,7 +2211,7 @@ Create a conversation. - `"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. @@ -2221,19 +2221,19 @@ Create a conversation. - `"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`. @@ -2247,7 +2247,7 @@ Create a conversation. - `"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). @@ -2261,11 +2261,11 @@ Create a conversation. - `"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. @@ -2277,7 +2277,7 @@ Create a conversation. - `"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. @@ -2307,11 +2307,11 @@ Create a conversation. 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. @@ -2321,7 +2321,7 @@ Create a conversation. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2333,11 +2333,11 @@ Create a conversation. 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. @@ -2355,7 +2355,7 @@ Create a conversation. The IDs of the vector stores to search. - - `filters: optional ComparisonFilter or CompoundFilter` + - `filters: optional ComparisonFilter or CompoundFilter or null` A filter to apply. @@ -2454,11 +2454,11 @@ Create a conversation. - `"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. @@ -2475,23 +2475,23 @@ Create a conversation. - `"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`. @@ -2516,7 +2516,7 @@ Create a conversation. - `"mcp"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2524,7 +2524,7 @@ Create a conversation. - `"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. @@ -2589,12 +2589,12 @@ Create a conversation. 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. @@ -2684,7 +2684,7 @@ Create a conversation. 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. @@ -2710,7 +2710,7 @@ Create a conversation. - `"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). @@ -2757,7 +2757,7 @@ Create a conversation. - `"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`. @@ -2872,7 +2872,7 @@ Create a conversation. - `"shell"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2880,7 +2880,7 @@ Create a conversation. - `"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 }` @@ -2902,7 +2902,7 @@ Create a conversation. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2946,7 +2946,7 @@ Create a conversation. - `"function"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -2958,15 +2958,15 @@ Create a conversation. 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. @@ -2984,7 +2984,7 @@ Create a conversation. - `"custom"` - - `allowed_callers: optional array of "direct" or "programmatic"` + - `allowed_callers: optional array of "direct" or "programmatic" or null` The tool invocation context(s). @@ -3020,7 +3020,7 @@ Create a conversation. - `"tool_search"` - - `description: optional string` + - `description: optional string or null` Description shown to the model for a client-executed tool search tool. @@ -3032,7 +3032,7 @@ Create a conversation. - `"client"` - - `parameters: optional unknown` + - `parameters: optional unknown or null` Parameter schema for a client-executed tool search tool. @@ -3064,7 +3064,7 @@ Create a conversation. - `"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. @@ -3074,19 +3074,19 @@ Create a conversation. - `"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`. @@ -3100,7 +3100,7 @@ Create a conversation. - `"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). @@ -3114,7 +3114,7 @@ Create a conversation. - `"additional_tools"` - - `id: optional string` + - `id: optional string or null` The unique ID of this additional tools item. @@ -3163,7 +3163,7 @@ Create a conversation. - `"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 @@ -3194,7 +3194,7 @@ Create a conversation. - `"compaction"` - - `id: optional string` + - `id: optional string or null` The ID of the compaction item. @@ -3206,7 +3206,7 @@ Create a conversation. The unique ID of the image generation call. - - `result: string` + - `result: string or null` The generated image encoded in base64. @@ -3236,7 +3236,7 @@ Create a conversation. The unique ID of the code interpreter tool call. - - `code: string` + - `code: string or null` The code to run, or null if not available. @@ -3244,7 +3244,7 @@ Create a conversation. 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. @@ -3323,15 +3323,15 @@ Create a conversation. - `"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. @@ -3373,7 +3373,7 @@ Create a conversation. - `"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`. @@ -3395,11 +3395,11 @@ Create a conversation. 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. @@ -3413,11 +3413,11 @@ Create a conversation. - `"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. @@ -3441,7 +3441,7 @@ Create a conversation. - `"program"` - - `environment: optional LocalEnvironment or ContainerReference` + - `environment: optional LocalEnvironment or ContainerReference or null` The environment to execute the shell commands in. @@ -3449,7 +3449,7 @@ Create a conversation. - `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`. @@ -3513,11 +3513,11 @@ Create a conversation. - `"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. @@ -3541,11 +3541,11 @@ Create a conversation. - `"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. @@ -3631,11 +3631,11 @@ Create a conversation. - `"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. @@ -3681,11 +3681,11 @@ Create a conversation. - `"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. @@ -3709,7 +3709,7 @@ Create a conversation. - `"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). @@ -3737,11 +3737,11 @@ Create a conversation. 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. @@ -3751,7 +3751,7 @@ Create a conversation. - `"mcp_list_tools"` - - `error: optional string` + - `error: optional string or null` Error message if the server could not list tools. @@ -3799,11 +3799,11 @@ Create a conversation. - `"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. @@ -3833,16 +3833,16 @@ Create a conversation. - `"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. @@ -3903,7 +3903,7 @@ Create a conversation. 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. @@ -3953,7 +3953,7 @@ Create a conversation. 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. @@ -3995,7 +3995,7 @@ Create a conversation. 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`. @@ -4053,7 +4053,7 @@ Create a conversation. - `"program_output"` -- `metadata: optional Metadata` +- `metadata: optional Metadata or null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -4271,7 +4271,7 @@ Update a conversation ### Body Parameters -- `metadata: Metadata` +- `metadata: Metadata or null` Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured @@ -4369,11 +4369,11 @@ curl https://api.openai.com/v1/conversations/conv_123 \ - `"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. @@ -4682,11 +4682,11 @@ curl https://api.openai.com/v1/conversations/conv_123 \ - `"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. @@ -4716,11 +4716,11 @@ curl https://api.openai.com/v1/conversations/conv_123 \ - `"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. @@ -4764,7 +4764,7 @@ curl https://api.openai.com/v1/conversations/conv_123 \ 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. @@ -4822,7 +4822,7 @@ curl https://api.openai.com/v1/conversations/conv_123 \ - `"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. @@ -4967,11 +4967,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. @@ -5009,7 +5009,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. @@ -5044,7 +5044,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 @@ -5277,7 +5277,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 @@ -5321,11 +5321,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 @@ -5376,11 +5376,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. @@ -5437,7 +5437,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. @@ -5445,7 +5445,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. @@ -5492,7 +5492,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. @@ -5528,7 +5528,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. @@ -5568,7 +5568,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. @@ -5670,11 +5670,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. @@ -5682,15 +5682,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. @@ -5756,7 +5756,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. @@ -5823,7 +5823,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. @@ -5892,7 +5892,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. @@ -5912,7 +5912,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`. @@ -5924,15 +5924,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. @@ -5962,23 +5962,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. @@ -5994,11 +5994,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. @@ -6022,15 +6022,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. @@ -6052,11 +6052,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. @@ -6068,7 +6068,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. @@ -6092,11 +6092,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. @@ -6106,7 +6106,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). @@ -6118,11 +6118,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. @@ -6140,7 +6140,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. @@ -6306,11 +6306,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. @@ -6327,23 +6327,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`. @@ -6368,7 +6368,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). @@ -6376,7 +6376,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. @@ -6441,12 +6441,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. @@ -6536,7 +6536,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. @@ -6594,7 +6594,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). @@ -6641,7 +6641,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`. @@ -6756,7 +6756,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). @@ -6764,7 +6764,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 }` @@ -6778,7 +6778,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. @@ -6904,7 +6904,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). @@ -6980,7 +6980,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). @@ -6992,15 +6992,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. @@ -7018,7 +7018,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). @@ -7054,7 +7054,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. @@ -7066,7 +7066,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. @@ -7098,7 +7098,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. @@ -7108,19 +7108,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`. @@ -7134,7 +7134,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). @@ -7148,11 +7148,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. @@ -7164,7 +7164,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. @@ -7194,11 +7194,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. @@ -7208,7 +7208,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). @@ -7220,11 +7220,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. @@ -7242,7 +7242,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. @@ -7341,11 +7341,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. @@ -7362,23 +7362,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`. @@ -7403,7 +7403,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). @@ -7411,7 +7411,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. @@ -7476,12 +7476,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. @@ -7571,7 +7571,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. @@ -7597,7 +7597,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). @@ -7644,7 +7644,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`. @@ -7759,7 +7759,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). @@ -7767,7 +7767,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 }` @@ -7789,7 +7789,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). @@ -7833,7 +7833,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). @@ -7845,15 +7845,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. @@ -7871,7 +7871,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). @@ -7907,7 +7907,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. @@ -7919,7 +7919,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. @@ -7951,7 +7951,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. @@ -7961,19 +7961,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`. @@ -7987,7 +7987,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). @@ -8001,7 +8001,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. @@ -8050,7 +8050,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 @@ -8081,7 +8081,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. @@ -8093,7 +8093,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. @@ -8123,7 +8123,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. @@ -8131,7 +8131,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. @@ -8210,15 +8210,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. @@ -8260,7 +8260,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`. @@ -8282,11 +8282,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. @@ -8300,11 +8300,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. @@ -8328,7 +8328,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. @@ -8336,7 +8336,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`. @@ -8400,11 +8400,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. @@ -8428,11 +8428,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. @@ -8518,11 +8518,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. @@ -8568,11 +8568,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. @@ -8596,7 +8596,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). @@ -8624,11 +8624,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. @@ -8638,7 +8638,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. @@ -8686,11 +8686,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. @@ -8720,16 +8720,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. @@ -8790,7 +8790,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. @@ -8840,7 +8840,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. @@ -8882,7 +8882,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`. @@ -9190,11 +9190,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. @@ -9224,11 +9224,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. @@ -9272,7 +9272,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. @@ -9330,7 +9330,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. @@ -9373,7 +9373,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. @@ -9453,7 +9453,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. @@ -9523,11 +9523,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 @@ -9613,7 +9613,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. @@ -9661,7 +9661,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. @@ -9704,11 +9704,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. @@ -9765,7 +9765,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. @@ -9773,7 +9773,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. @@ -9820,7 +9820,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. @@ -9856,7 +9856,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. @@ -9896,7 +9896,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. @@ -10022,11 +10022,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. @@ -10044,7 +10044,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. @@ -10082,7 +10082,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. @@ -10116,11 +10116,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. @@ -10130,7 +10130,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). @@ -10142,11 +10142,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. @@ -10164,7 +10164,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. @@ -10330,11 +10330,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. @@ -10351,23 +10351,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`. @@ -10392,7 +10392,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). @@ -10400,7 +10400,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. @@ -10465,12 +10465,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. @@ -10560,7 +10560,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. @@ -10618,7 +10618,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). @@ -10665,7 +10665,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`. @@ -10780,7 +10780,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). @@ -10788,7 +10788,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 }` @@ -10802,7 +10802,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. @@ -10928,7 +10928,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). @@ -11004,7 +11004,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). @@ -11016,15 +11016,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. @@ -11042,7 +11042,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). @@ -11078,7 +11078,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. @@ -11090,7 +11090,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. @@ -11122,7 +11122,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. @@ -11132,19 +11132,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`. @@ -11158,7 +11158,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). @@ -11214,11 +11214,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. @@ -11228,7 +11228,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). @@ -11240,11 +11240,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. @@ -11262,7 +11262,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. @@ -11361,11 +11361,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. @@ -11382,23 +11382,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`. @@ -11423,7 +11423,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). @@ -11431,7 +11431,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. @@ -11496,12 +11496,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. @@ -11591,7 +11591,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. @@ -11617,7 +11617,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). @@ -11664,7 +11664,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`. @@ -11779,7 +11779,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). @@ -11787,7 +11787,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 }` @@ -11809,7 +11809,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). @@ -11853,7 +11853,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). @@ -11865,15 +11865,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. @@ -11891,7 +11891,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). @@ -11927,7 +11927,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. @@ -11939,7 +11939,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. @@ -11971,7 +11971,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. @@ -11981,19 +11981,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`. @@ -12007,7 +12007,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). @@ -12064,7 +12064,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 @@ -12163,7 +12163,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. @@ -12171,7 +12171,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. @@ -12250,15 +12250,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. @@ -12300,7 +12300,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`. @@ -12324,11 +12324,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. @@ -12336,7 +12336,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. @@ -12378,7 +12378,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. @@ -12414,7 +12414,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. @@ -12478,7 +12478,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. @@ -12582,7 +12582,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. @@ -12632,7 +12632,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. @@ -12656,7 +12656,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. @@ -12684,11 +12684,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. @@ -12698,7 +12698,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. @@ -12750,7 +12750,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. @@ -12780,16 +12780,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. @@ -12833,7 +12833,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. @@ -12900,7 +12900,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. @@ -13427,11 +13427,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. @@ -13461,11 +13461,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. @@ -13509,7 +13509,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. @@ -13567,7 +13567,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. @@ -13610,7 +13610,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. @@ -13690,7 +13690,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. @@ -13760,11 +13760,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 @@ -13850,7 +13850,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. @@ -13898,7 +13898,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. @@ -13941,11 +13941,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. @@ -14002,7 +14002,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. @@ -14010,7 +14010,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. @@ -14057,7 +14057,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. @@ -14093,7 +14093,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. @@ -14133,7 +14133,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. @@ -14259,11 +14259,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. @@ -14281,7 +14281,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. @@ -14319,7 +14319,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. @@ -14353,11 +14353,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. @@ -14367,7 +14367,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). @@ -14379,11 +14379,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. @@ -14401,7 +14401,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. @@ -14567,11 +14567,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. @@ -14588,23 +14588,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`. @@ -14629,7 +14629,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). @@ -14637,7 +14637,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. @@ -14702,12 +14702,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. @@ -14797,7 +14797,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. @@ -14855,7 +14855,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). @@ -14902,7 +14902,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`. @@ -15017,7 +15017,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). @@ -15025,7 +15025,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 }` @@ -15039,7 +15039,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. @@ -15165,7 +15165,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). @@ -15241,7 +15241,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). @@ -15253,15 +15253,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. @@ -15279,7 +15279,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). @@ -15315,7 +15315,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. @@ -15327,7 +15327,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. @@ -15359,7 +15359,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. @@ -15369,19 +15369,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`. @@ -15395,7 +15395,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). @@ -15451,11 +15451,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. @@ -15465,7 +15465,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). @@ -15477,11 +15477,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. @@ -15499,7 +15499,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. @@ -15598,11 +15598,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. @@ -15619,23 +15619,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`. @@ -15660,7 +15660,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). @@ -15668,7 +15668,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. @@ -15733,12 +15733,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. @@ -15828,7 +15828,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. @@ -15854,7 +15854,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). @@ -15901,7 +15901,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`. @@ -16016,7 +16016,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). @@ -16024,7 +16024,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 }` @@ -16046,7 +16046,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). @@ -16090,7 +16090,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). @@ -16102,15 +16102,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. @@ -16128,7 +16128,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). @@ -16164,7 +16164,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. @@ -16176,7 +16176,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. @@ -16208,7 +16208,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. @@ -16218,19 +16218,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`. @@ -16244,7 +16244,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). @@ -16301,7 +16301,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 @@ -16400,7 +16400,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. @@ -16408,7 +16408,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. @@ -16487,15 +16487,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. @@ -16537,7 +16537,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`. @@ -16561,11 +16561,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. @@ -16573,7 +16573,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. @@ -16615,7 +16615,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. @@ -16651,7 +16651,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. @@ -16715,7 +16715,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. @@ -16819,7 +16819,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. @@ -16869,7 +16869,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. @@ -16893,7 +16893,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. @@ -16921,11 +16921,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. @@ -16935,7 +16935,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. @@ -16987,7 +16987,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. @@ -17017,16 +17017,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. @@ -17070,7 +17070,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. @@ -17137,7 +17137,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. @@ -17525,11 +17525,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. @@ -17559,11 +17559,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. @@ -17607,7 +17607,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. @@ -17665,7 +17665,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. @@ -17708,7 +17708,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. @@ -17788,7 +17788,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. @@ -17858,11 +17858,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 @@ -17948,7 +17948,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. @@ -17996,7 +17996,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. @@ -18039,11 +18039,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. @@ -18100,7 +18100,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. @@ -18108,7 +18108,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. @@ -18155,7 +18155,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. @@ -18191,7 +18191,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. @@ -18231,7 +18231,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. @@ -18357,11 +18357,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. @@ -18379,7 +18379,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. @@ -18417,7 +18417,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. @@ -18451,11 +18451,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. @@ -18465,7 +18465,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). @@ -18477,11 +18477,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. @@ -18499,7 +18499,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. @@ -18665,11 +18665,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. @@ -18686,23 +18686,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`. @@ -18727,7 +18727,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). @@ -18735,7 +18735,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. @@ -18800,12 +18800,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. @@ -18895,7 +18895,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. @@ -18953,7 +18953,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). @@ -19000,7 +19000,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`. @@ -19115,7 +19115,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). @@ -19123,7 +19123,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 }` @@ -19137,7 +19137,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. @@ -19263,7 +19263,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). @@ -19339,7 +19339,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). @@ -19351,15 +19351,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. @@ -19377,7 +19377,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). @@ -19413,7 +19413,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. @@ -19425,7 +19425,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. @@ -19457,7 +19457,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. @@ -19467,19 +19467,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`. @@ -19493,7 +19493,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). @@ -19549,11 +19549,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. @@ -19563,7 +19563,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). @@ -19575,11 +19575,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. @@ -19597,7 +19597,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. @@ -19696,11 +19696,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. @@ -19717,23 +19717,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`. @@ -19758,7 +19758,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). @@ -19766,7 +19766,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. @@ -19831,12 +19831,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. @@ -19926,7 +19926,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. @@ -19952,7 +19952,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). @@ -19999,7 +19999,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`. @@ -20114,7 +20114,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). @@ -20122,7 +20122,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 }` @@ -20144,7 +20144,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). @@ -20188,7 +20188,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). @@ -20200,15 +20200,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. @@ -20226,7 +20226,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). @@ -20262,7 +20262,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. @@ -20274,7 +20274,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. @@ -20306,7 +20306,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. @@ -20316,19 +20316,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`. @@ -20342,7 +20342,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). @@ -20399,7 +20399,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 @@ -20498,7 +20498,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. @@ -20506,7 +20506,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. @@ -20585,15 +20585,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. @@ -20635,7 +20635,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`. @@ -20659,11 +20659,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. @@ -20671,7 +20671,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. @@ -20713,7 +20713,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. @@ -20749,7 +20749,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. @@ -20813,7 +20813,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. @@ -20917,7 +20917,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. @@ -20967,7 +20967,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. @@ -20991,7 +20991,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. @@ -21019,11 +21019,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. @@ -21033,7 +21033,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. @@ -21085,7 +21085,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. @@ -21115,16 +21115,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. @@ -21168,7 +21168,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. @@ -21235,7 +21235,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. @@ -21556,11 +21556,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. @@ -21590,11 +21590,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. @@ -21638,7 +21638,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. @@ -21696,7 +21696,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. @@ -21739,7 +21739,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. @@ -21819,7 +21819,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. @@ -21889,11 +21889,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 @@ -21979,7 +21979,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. @@ -22027,7 +22027,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. @@ -22070,11 +22070,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. @@ -22131,7 +22131,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. @@ -22139,7 +22139,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. @@ -22186,7 +22186,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. @@ -22222,7 +22222,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. @@ -22262,7 +22262,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. @@ -22388,11 +22388,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. @@ -22410,7 +22410,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. @@ -22448,7 +22448,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. @@ -22482,11 +22482,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. @@ -22496,7 +22496,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). @@ -22508,11 +22508,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. @@ -22530,7 +22530,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. @@ -22696,11 +22696,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. @@ -22717,23 +22717,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`. @@ -22758,7 +22758,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). @@ -22766,7 +22766,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. @@ -22831,12 +22831,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. @@ -22926,7 +22926,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. @@ -22984,7 +22984,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). @@ -23031,7 +23031,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`. @@ -23146,7 +23146,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). @@ -23154,7 +23154,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 }` @@ -23168,7 +23168,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. @@ -23294,7 +23294,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). @@ -23370,7 +23370,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). @@ -23382,15 +23382,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. @@ -23408,7 +23408,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). @@ -23444,7 +23444,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. @@ -23456,7 +23456,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. @@ -23488,7 +23488,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. @@ -23498,19 +23498,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`. @@ -23524,7 +23524,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). @@ -23580,11 +23580,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. @@ -23594,7 +23594,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). @@ -23606,11 +23606,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. @@ -23628,7 +23628,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. @@ -23727,11 +23727,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. @@ -23748,23 +23748,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`. @@ -23789,7 +23789,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). @@ -23797,7 +23797,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. @@ -23862,12 +23862,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. @@ -23957,7 +23957,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. @@ -23983,7 +23983,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). @@ -24030,7 +24030,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`. @@ -24145,7 +24145,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). @@ -24153,7 +24153,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 }` @@ -24175,7 +24175,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). @@ -24219,7 +24219,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). @@ -24231,15 +24231,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. @@ -24257,7 +24257,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). @@ -24293,7 +24293,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. @@ -24305,7 +24305,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. @@ -24337,7 +24337,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. @@ -24347,19 +24347,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`. @@ -24373,7 +24373,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). @@ -24430,7 +24430,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 @@ -24529,7 +24529,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. @@ -24537,7 +24537,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. @@ -24616,15 +24616,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. @@ -24666,7 +24666,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`. @@ -24690,11 +24690,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. @@ -24702,7 +24702,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. @@ -24744,7 +24744,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. @@ -24780,7 +24780,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. @@ -24844,7 +24844,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. @@ -24948,7 +24948,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. @@ -24998,7 +24998,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. @@ -25022,7 +25022,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. @@ -25050,11 +25050,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. @@ -25064,7 +25064,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. @@ -25116,7 +25116,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. @@ -25146,16 +25146,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. @@ -25199,7 +25199,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. @@ -25266,7 +25266,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. @@ -25540,11 +25540,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. @@ -25574,11 +25574,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. @@ -25622,7 +25622,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. @@ -25680,7 +25680,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. @@ -25723,7 +25723,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. @@ -25803,7 +25803,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. @@ -25873,11 +25873,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 @@ -25963,7 +25963,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. @@ -26011,7 +26011,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. @@ -26054,11 +26054,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. @@ -26115,7 +26115,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. @@ -26123,7 +26123,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. @@ -26170,7 +26170,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. @@ -26206,7 +26206,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. @@ -26246,7 +26246,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. @@ -26372,11 +26372,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. @@ -26394,7 +26394,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. @@ -26432,7 +26432,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. @@ -26466,11 +26466,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. @@ -26480,7 +26480,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). @@ -26492,11 +26492,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. @@ -26514,7 +26514,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. @@ -26680,11 +26680,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. @@ -26701,23 +26701,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`. @@ -26742,7 +26742,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). @@ -26750,7 +26750,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. @@ -26815,12 +26815,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. @@ -26910,7 +26910,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. @@ -26968,7 +26968,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). @@ -27015,7 +27015,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`. @@ -27130,7 +27130,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). @@ -27138,7 +27138,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 }` @@ -27152,7 +27152,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. @@ -27278,7 +27278,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). @@ -27354,7 +27354,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). @@ -27366,15 +27366,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. @@ -27392,7 +27392,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). @@ -27428,7 +27428,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. @@ -27440,7 +27440,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. @@ -27472,7 +27472,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. @@ -27482,19 +27482,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`. @@ -27508,7 +27508,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). @@ -27564,11 +27564,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. @@ -27578,7 +27578,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). @@ -27590,11 +27590,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. @@ -27612,7 +27612,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. @@ -27711,11 +27711,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. @@ -27732,23 +27732,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`. @@ -27773,7 +27773,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). @@ -27781,7 +27781,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. @@ -27846,12 +27846,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. @@ -27941,7 +27941,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. @@ -27967,7 +27967,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). @@ -28014,7 +28014,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`. @@ -28129,7 +28129,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). @@ -28137,7 +28137,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 }` @@ -28159,7 +28159,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). @@ -28203,7 +28203,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). @@ -28215,15 +28215,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. @@ -28241,7 +28241,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). @@ -28277,7 +28277,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. @@ -28289,7 +28289,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. @@ -28321,7 +28321,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. @@ -28331,19 +28331,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`. @@ -28357,7 +28357,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). @@ -28414,7 +28414,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 @@ -28513,7 +28513,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. @@ -28521,7 +28521,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. @@ -28600,15 +28600,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. @@ -28650,7 +28650,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`. @@ -28674,11 +28674,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. @@ -28686,7 +28686,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. @@ -28728,7 +28728,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. @@ -28764,7 +28764,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. @@ -28828,7 +28828,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. @@ -28932,7 +28932,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. @@ -28982,7 +28982,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. @@ -29006,7 +29006,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. @@ -29034,11 +29034,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. @@ -29048,7 +29048,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. @@ -29100,7 +29100,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. @@ -29130,16 +29130,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. @@ -29183,7 +29183,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. @@ -29250,7 +29250,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.