Azure OpenAI responses

API Version: v1

Server: {endpoint}/openai/v1 — Azure AI Foundry Models APIs

Server Variables:

Variable	Default	Description
endpoint		A supported Azure AI Foundry Models APIs endpoint, including protocol and hostname. For example: https://westus.api.cognitive.microsoft.com).

Authentication

ApiKeyAuth (API Key)

Pass your API key in the api-key header.

ApiKeyAuth_ (API Key)

Pass your API key in the authorization header.

OAuth2Auth (OAuth 2.0)

Flow: implicit

Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes:

• https://cognitiveservices.azure.com/.default

Security Requirements

Endpoints accept any one of the following authentication methods:

1. ApiKeyAuth
2. ApiKeyAuth_
3. OAuth2Auth (scopes: https://cognitiveservices.azure.com/.default)

Create response

POST {endpoint}/openai/v1/responses

Creates a model response.

URI Parameters

Name	In	Required	Type	Description
endpoint	server	Yes	string	A supported Azure AI Foundry Models APIs endpoint, including protocol and hostname. For example: https://westus.api.cognitive.microsoft.com).
api-version	query	No	string Possible values: v1, preview	The explicit Azure AI Foundry Models API version to use for this request. v1 if not otherwise specified.

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
background	boolean or null		No
conversation	OpenAI.ConversationParam or null		No
include	array of OpenAI.IncludeEnum or null		No
input	OpenAI.InputParam	Text, image, or file inputs to the model, used to generate a response. Learn more: - Text inputs and outputs - Image inputs - File inputs - Conversation state - Function calling	No
instructions	string or null		No
max_output_tokens	integer or null		No
max_tool_calls	integer or null		No
metadata	OpenAI.Metadata or null		No
model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
parallel_tool_calls	boolean or null		No
previous_response_id	string or null		No
prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
prompt_cache_retention	string or null		No
reasoning	OpenAI.Reasoning or null		No
safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
store	boolean or null		No
stream	boolean or null		No
stream_options	OpenAI.ResponseStreamOptions or null		No
temperature	number or null		No
text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. The two categories of tools you can provide the model are: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like file search. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code.	No
top_logprobs	integer or null		No
top_p	number or null		No
truncation	string or null		No
user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No

Responses

Status Code: 200

Description: The request has succeeded.

Content-Type	Type	Description
application/json	object
text/event-stream	object

Name	Type	Description	Required	Default
background	boolean or null		No
completed_at	string or null		No
content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
conversation	OpenAI.ConversationReference or null		No
created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
error	OpenAI.ResponseError or null		Yes
id	string	Unique identifier for this Response.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
instructions	string or array of OpenAI.InputItem or null		Yes
max_output_tokens	integer or null		No
max_tool_calls	integer or null		No
metadata	OpenAI.Metadata or null		No
model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
object	enum	The object type of this resource - always set to response. Possible values: response	Yes
output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
output_text	string or null		No
parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
previous_response_id	string or null		No
prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
prompt_cache_retention	string or null		No
reasoning	OpenAI.Reasoning or null		No
safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
temperature	number or null		No
text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
top_logprobs	integer or null		No
top_p	number or null		No
truncation	string or null		No
usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Status Code: default

Description: An unexpected error response.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
code	string or null		Yes
inner_error			No
message	string		Yes
param	string or null		Yes
type	string		Yes

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Examples

Example

Create a model response

POST {endpoint}/openai/v1/responses?api-version=v1

Get response

GET {endpoint}/openai/v1/responses/{response_id}

Retrieves a model response with the given ID.

URI Parameters

Name	In	Required	Type	Description
endpoint	server	Yes	string	A supported Azure AI Foundry Models APIs endpoint, including protocol and hostname. For example: https://westus.api.cognitive.microsoft.com).
api-version	query	No	string Possible values: v1, preview	The explicit Azure AI Foundry Models API version to use for this request. v1 if not otherwise specified.
response_id	path	Yes	string
include[]	query	No	array	Additional fields to include in the response. See the include parameter for Response creation above for more information.
stream	query	No	boolean	If set to true, the model response data will be streamed to the client as it is generated using server-sent events. Serialization: explode: false
starting_after	query	No	integer (int32)	The sequence number of the event after which to start streaming. Serialization: explode: false
include_obfuscation	query	No	boolean	When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API. Serialization: explode: false

Responses

Status Code: 200

Description: The request has succeeded.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
background	boolean or null		No
completed_at	string or null		No
content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
conversation	OpenAI.ConversationReference or null		No
created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
error	OpenAI.ResponseError or null		Yes
id	string	Unique identifier for this Response.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
instructions	string or array of OpenAI.InputItem or null		Yes
max_output_tokens	integer or null		No
max_tool_calls	integer or null		No
metadata	OpenAI.Metadata or null		No
model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
object	enum	The object type of this resource - always set to response. Possible values: response	Yes
output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
output_text	string or null		No
parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
previous_response_id	string or null		No
prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
prompt_cache_retention	string or null		No
reasoning	OpenAI.Reasoning or null		No
safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
temperature	number or null		No
text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
top_logprobs	integer or null		No
top_p	number or null		No
truncation	string or null		No
usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Status Code: default

Description: An unexpected error response.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
code	string or null		Yes
inner_error			No
message	string		Yes
param	string or null		Yes
type	string		Yes

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Delete response

DELETE {endpoint}/openai/v1/responses/{response_id}

Deletes a response by ID.

URI Parameters

Name	In	Required	Type	Description
endpoint	server	Yes	string	A supported Azure AI Foundry Models APIs endpoint, including protocol and hostname. For example: https://westus.api.cognitive.microsoft.com).
api-version	query	No	string Possible values: v1, preview	The explicit Azure AI Foundry Models API version to use for this request. v1 if not otherwise specified.
response_id	path	Yes	string

Responses

Status Code: 200

Description: The request has succeeded.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
deleted	enum	Possible values: True	Yes
id	string		Yes
object	enum	Possible values: response.deleted	Yes

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Status Code: default

Description: An unexpected error response.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
code	string or null		Yes
inner_error			No
message	string		Yes
param	string or null		Yes
type	string		Yes

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Cancel response

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled.

URI Parameters

Name	In	Required	Type	Description
endpoint	server	Yes	string	A supported Azure AI Foundry Models APIs endpoint, including protocol and hostname. For example: https://westus.api.cognitive.microsoft.com).
api-version	query	No	string Possible values: v1, preview	The explicit Azure AI Foundry Models API version to use for this request. v1 if not otherwise specified.
response_id	path	Yes	string

Responses

Status Code: 200

Description: The request has succeeded.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
background	boolean or null		No
completed_at	string or null		No
content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
conversation	OpenAI.ConversationReference or null		No
created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
error	OpenAI.ResponseError or null		Yes
id	string	Unique identifier for this Response.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
instructions	string or array of OpenAI.InputItem or null		Yes
max_output_tokens	integer or null		No
max_tool_calls	integer or null		No
metadata	OpenAI.Metadata or null		No
model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
object	enum	The object type of this resource - always set to response. Possible values: response	Yes
output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
output_text	string or null		No
parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
previous_response_id	string or null		No
prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
prompt_cache_retention	string or null		No
reasoning	OpenAI.Reasoning or null		No
safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
temperature	number or null		No
text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
top_logprobs	integer or null		No
top_p	number or null		No
truncation	string or null		No
usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Status Code: default

Description: An unexpected error response.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
code	string or null		Yes
inner_error			No
message	string		Yes
param	string or null		Yes
type	string		Yes

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

List input items

GET {endpoint}/openai/v1/responses/{response_id}/input_items

Returns a list of input items for a given response.

URI Parameters

Name	In	Required	Type	Description
endpoint	server	Yes	string	A supported Azure AI Foundry Models APIs endpoint, including protocol and hostname. For example: https://westus.api.cognitive.microsoft.com).
api-version	query	No	string Possible values: v1, preview	The explicit Azure AI Foundry Models API version to use for this request. v1 if not otherwise specified.
response_id	path	Yes	string
limit	query	No	integer (int32)	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Serialization: explode: false
order	query	No	string Possible values: asc, desc	Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order. Serialization: explode: false
after	query	No	string	A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. Serialization: explode: false
before	query	No	string	A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. Serialization: explode: false

Responses

Status Code: 200

Description: The request has succeeded.

Content-Type	Type	Description
application/json	OpenAI.ResponseItemList

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Status Code: default

Description: An unexpected error response.

Content-Type	Type	Description
application/json	object

Name	Type	Description	Required	Default
code	string or null		Yes
inner_error			No
message	string		Yes
param	string or null		Yes
type	string		Yes

Response Headers:

Header	Type	Description
apim-request-id	string	A request ID used for troubleshooting purposes.

Components

AzureAIFoundryModelsApiVersion

Property	Value
Type	string
Values	v1 preview

AzureContentFilterBlocklistResult

A collection of true/false filtering results for configured custom blocklists.

Name	Type	Description	Required	Default
details	array of object	The pairs of individual blocklist IDs and whether they resulted in a filtering action.	No
filtered	boolean	A value indicating whether any of the detailed blocklists resulted in a filtering action.	Yes

AzureContentFilterCompletionTextSpan

A representation of a span of completion text as used by Azure OpenAI content filter results.

Name	Type	Description	Required	Default
completion_end_offset	integer (int32)	Offset of the first UTF32 code point which is excluded from the span. This field is always equal to completion_start_offset for empty spans. This field is always larger than completion_start_offset for non-empty spans.	Yes
completion_start_offset	integer (int32)	Offset of the UTF32 code point which begins the span.	Yes

AzureContentFilterCompletionTextSpanDetectionResult

Name	Type	Description	Required	Default
details	array of AzureContentFilterCompletionTextSpan	Detailed information about the detected completion text spans.	Yes
detected	boolean	Whether the labeled content category was detected in the content.	Yes
filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes

AzureContentFilterCustomTopicResult

A collection of true/false filtering results for configured custom topics.

Name	Type	Description	Required	Default
details	array of object	The pairs of individual topic IDs and whether they are detected.	No
filtered	boolean	A value indicating whether any of the detailed topics resulted in a filtering action.	Yes

AzureContentFilterDetectionResult

A labeled content filter result item that indicates whether the content was detected and whether the content was filtered.

Name	Type	Description	Required	Default
detected	boolean	Whether the labeled content category was detected in the content.	Yes
filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes

AzureContentFilterForResponsesAPI

Name	Type	Description	Required	Default
blocked	boolean	Indicate if the response is blocked.	Yes
content_filter_offsets	AzureContentFilterResultOffsets		Yes
content_filter_results	AzureContentFilterResultsForResponsesAPI		Yes
└─ custom_blocklists	AzureContentFilterBlocklistResult	A collection of binary filtering outcomes for configured custom blocklists.	No
└─ custom_topics	AzureContentFilterCustomTopicResult	A collection of binary filtering outcomes for configured custom topics.	No
└─ error	object	If present, details about an error that prevented content filtering from completing its evaluation.	No
└─ code	integer (int32)	A distinct, machine-readable code associated with the error.	Yes
└─ message	string	A human-readable message associated with the error.	Yes
└─ hate	AzureContentFilterSeverityResult	A content filter category that can refer to any content that attacks or uses pejorative or discriminatory language with reference to a person or identity group based on certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.	No
└─ indirect_attack	AzureContentFilterDetectionResult	A detection result that describes attacks on systems powered by Generative AI models that can happen every time an application processes information that wasn’t directly authored by either the developer of the application or the user.	No
└─ jailbreak	AzureContentFilterDetectionResult	A detection result that describes user prompt injection attacks, where malicious users deliberately exploit system vulnerabilities to elicit unauthorized behavior from the LLM. This could lead to inappropriate content generation or violations of system-imposed restrictions.	Yes
└─ personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	A detection result that describes matches against Personal Identifiable Information with configurable subcategories.	No
└─ profanity	AzureContentFilterDetectionResult	A detection result that identifies whether crude, vulgar, or otherwise objection language is present in the content.	No
└─ protected_material_code	object	A detection result that describes a match against licensed code or other protected source material.	No
└─ citation	object	If available, the citation details describing the associated license and its location.	No
└─ URL	string (uri)	The URL associated with the license.	No
└─ license	string	The name or identifier of the license associated with the detection.	No
└─ detected	boolean	Whether the labeled content category was detected in the content.	Yes
└─ filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
└─ protected_material_text	AzureContentFilterDetectionResult	A detection result that describes a match against text protected under copyright or other status.	No
└─ self_harm	AzureContentFilterSeverityResult	A content filter category that describes language related to physical actions intended to purposely hurt, injure, damage one's body or kill oneself.	No
└─ sexual	AzureContentFilterSeverityResult	A content filter category for language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, pregnancy, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one's will, prostitution, pornography, and abuse.	No
└─ task_adherence	AzureContentFilterDetectionResult	A detection result that indicates if the execution flow still sticks the plan.	Yes
└─ ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└─ violence	AzureContentFilterSeverityResult	A content filter category for language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, guns and related entities, such as manufactures, associations, legislation, and so on.	No
source_type	string	The name of the source type of the message.	Yes

AzureContentFilterPersonallyIdentifiableInformationResult

A content filter detection result for Personally Identifiable Information that includes harm extensions.

Name	Type	Description	Required	Default
detected	boolean	Whether the labeled content category was detected in the content.	Yes
filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
redacted_text	string	The redacted text with PII information removed or masked.	No
sub_categories	array of AzurePiiSubCategoryResult	Detailed results for individual PIIHarmSubCategory(s).	No

AzureContentFilterResultOffsets

Name	Type	Description	Required	Default
check_offset	integer (int32)		Yes
end_offset	integer (int32)		Yes
start_offset	integer (int32)		Yes

AzureContentFilterResultsForResponsesAPI

Name	Type	Description	Required	Default
custom_blocklists	AzureContentFilterBlocklistResult	A collection of true/false filtering results for configured custom blocklists.	No
└─ details	array of object	The pairs of individual blocklist IDs and whether they resulted in a filtering action.	No
└─ filtered	boolean	A value indicating whether the blocklist produced a filtering action.	Yes
└─ id	string	The ID of the custom blocklist evaluated.	Yes
└─ filtered	boolean	A value indicating whether any of the detailed blocklists resulted in a filtering action.	Yes
custom_topics	AzureContentFilterCustomTopicResult	A collection of true/false filtering results for configured custom topics.	No
└─ details	array of object	The pairs of individual topic IDs and whether they are detected.	No
└─ detected	boolean	A value indicating whether the topic is detected.	Yes
└─ id	string	The ID of the custom topic evaluated.	Yes
└─ filtered	boolean	A value indicating whether any of the detailed topics resulted in a filtering action.	Yes
error	object	If present, details about an error that prevented content filtering from completing its evaluation.	No
└─ code	integer (int32)	A distinct, machine-readable code associated with the error.	Yes
└─ message	string	A human-readable message associated with the error.	Yes
hate	AzureContentFilterSeverityResult	A labeled content filter result item that indicates whether the content was filtered and what the qualitative severity level of the content was, as evaluated against content filter configuration for the category.	No
└─ filtered	boolean	Whether the content severity resulted in a content filtering action.	Yes
└─ severity	enum	The labeled severity of the content. Possible values: safe, low, medium, high	Yes
indirect_attack	AzureContentFilterDetectionResult	A labeled content filter result item that indicates whether the content was detected and whether the content was filtered.	No
└─ detected	boolean	Whether the labeled content category was detected in the content.	Yes
└─ filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
jailbreak	AzureContentFilterDetectionResult	A labeled content filter result item that indicates whether the content was detected and whether the content was filtered.	Yes
└─ detected	boolean	Whether the labeled content category was detected in the content.	Yes
└─ filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	A content filter detection result for Personally Identifiable Information that includes harm extensions.	No
└─ redacted_text	string	The redacted text with PII information removed or masked.	No
└─ sub_categories	array of AzurePiiSubCategoryResult	Detailed results for individual PIIHarmSubCategory(s).	No
profanity	AzureContentFilterDetectionResult	A labeled content filter result item that indicates whether the content was detected and whether the content was filtered.	No
└─ detected	boolean	Whether the labeled content category was detected in the content.	Yes
└─ filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
protected_material_code	object	A detection result that describes a match against licensed code or other protected source material.	No
└─ citation	object	If available, the citation details describing the associated license and its location.	No
└─ URL	string (uri)	The URL associated with the license.	No
└─ license	string	The name or identifier of the license associated with the detection.	No
└─ detected	boolean	Whether the labeled content category was detected in the content.	Yes
└─ filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
protected_material_text	AzureContentFilterDetectionResult	A labeled content filter result item that indicates whether the content was detected and whether the content was filtered.	No
└─ detected	boolean	Whether the labeled content category was detected in the content.	Yes
└─ filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
self_harm	AzureContentFilterSeverityResult	A labeled content filter result item that indicates whether the content was filtered and what the qualitative severity level of the content was, as evaluated against content filter configuration for the category.	No
└─ filtered	boolean	Whether the content severity resulted in a content filtering action.	Yes
└─ severity	enum	The labeled severity of the content. Possible values: safe, low, medium, high	Yes
sexual	AzureContentFilterSeverityResult	A labeled content filter result item that indicates whether the content was filtered and what the qualitative severity level of the content was, as evaluated against content filter configuration for the category.	No
└─ filtered	boolean	Whether the content severity resulted in a content filtering action.	Yes
└─ severity	enum	The labeled severity of the content. Possible values: safe, low, medium, high	Yes
task_adherence	AzureContentFilterDetectionResult	A labeled content filter result item that indicates whether the content was detected and whether the content was filtered.	Yes
└─ detected	boolean	Whether the labeled content category was detected in the content.	Yes
└─ filtered	boolean	Whether the content detection resulted in a content filtering action.	Yes
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violence	AzureContentFilterSeverityResult	A labeled content filter result item that indicates whether the content was filtered and what the qualitative severity level of the content was, as evaluated against content filter configuration for the category.	No
└─ filtered	boolean	Whether the content severity resulted in a content filtering action.	Yes
└─ severity	enum	The labeled severity of the content. Possible values: safe, low, medium, high	Yes

AzureContentFilterSeverityResult

A labeled content filter result item that indicates whether the content was filtered and what the qualitative severity level of the content was, as evaluated against content filter configuration for the category.

Name	Type	Description	Required	Default
filtered	boolean	Whether the content severity resulted in a content filtering action.	Yes
severity	enum	The labeled severity of the content. Possible values: safe, low, medium, high	Yes

AzurePiiSubCategoryResult

Result details for individual PIIHarmSubCategory(s).

Name	Type	Description	Required	Default
detected	boolean	Whether the labeled content subcategory was detected in the content.	Yes
filtered	boolean	Whether the content detection resulted in a content filtering action for this subcategory.	Yes
redacted	boolean	Whether the content was redacted for this subcategory.	Yes
sub_category	string	The PIIHarmSubCategory that was evaluated.	Yes

OpenAI.Annotation

An annotation that applies to a span of output text.

Discriminator for OpenAI.Annotation

This component uses the property type to discriminate between different types:

Type Value	Schema
file_citation	OpenAI.FileCitationBody
url_citation	OpenAI.UrlCitationBody
container_file_citation	OpenAI.ContainerFileCitationBody
file_path	OpenAI.FilePath

Name	Type	Description	Required	Default
type	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

Property	Value
Type	string
Values	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

Property	Value
Type	string
Values	completed failed

OpenAI.ApplyPatchCallStatus

Property	Value
Type	string
Values	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

Apply patch create file operation

Instruction describing how to create a file via the apply_patch tool.

Name	Type	Description	Required	Default
diff	string	Diff to apply.	Yes
path	string	Path of the file to create.	Yes
type	enum	Create a new file with the provided diff. Possible values: create_file	Yes	create_file

OpenAI.ApplyPatchDeleteFileOperation

Apply patch delete file operation

Instruction describing how to delete a file via the apply_patch tool.

Name	Type	Description	Required	Default
path	string	Path of the file to delete.	Yes
type	enum	Delete the specified file. Possible values: delete_file	Yes	delete_file

OpenAI.ApplyPatchFileOperation

Apply patch operation

One of the create_file, delete_file, or update_file operations applied via apply_patch.

Discriminator for OpenAI.ApplyPatchFileOperation

This component uses the property type to discriminate between different types:

Type Value	Schema
create_file	OpenAI.ApplyPatchCreateFileOperation
delete_file	OpenAI.ApplyPatchDeleteFileOperation
update_file	OpenAI.ApplyPatchUpdateFileOperation

Name	Type	Description	Required	Default
type	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

Property	Value
Type	string
Values	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

Apply patch tool

Allows the assistant to create, delete, or update files using unified diffs.

Name	Type	Description	Required	Default
type	enum	The type of the tool. Always apply_patch. Possible values: apply_patch	Yes	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Apply patch update file operation

Instruction describing how to update a file via the apply_patch tool.

Name	Type	Description	Required	Default
diff	string	Diff to apply.	Yes
path	string	Path of the file to update.	Yes
type	enum	Update an existing file with the provided diff. Possible values: update_file	Yes	update_file

OpenAI.ApproximateLocation

Name	Type	Description	Required	Default
city	string or null		No
country	string or null		No
region	string or null		No
timezone	string or null		No
type	enum	The type of location approximation. Always approximate. Possible values: approximate	Yes	approximate

OpenAI.ClickButtonType

Property	Value
Type	string
Values	left right wheel back forward

OpenAI.ClickParam

Click

A click action.

Name	Type	Description	Required	Default
button	OpenAI.ClickButtonType		Yes
type	enum	Specifies the event type. For a click action, this property is always click. Possible values: click	Yes	click
x	integer	The x-coordinate where the click occurred.	Yes
y	integer	The y-coordinate where the click occurred.	Yes

OpenAI.CodeInterpreterContainerAuto

CodeInterpreterToolAuto

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

Name	Type	Description	Required	Default
file_ids	array of string	An optional list of uploaded files to make available to your code. Constraints: maxItems: 50	No
memory_limit	OpenAI.ContainerMemoryLimit or null		No
type	enum	Always auto. Possible values: auto	Yes	auto

OpenAI.CodeInterpreterOutputImage

Code interpreter output image

The image output from the code interpreter.

Name	Type	Description	Required	Default
type	enum	The type of the output. Always image. Possible values: image	Yes	image
url	string (uri)	The URL of the image output from the code interpreter.	Yes

OpenAI.CodeInterpreterOutputLogs

Code interpreter output logs

The logs output from the code interpreter.

Name	Type	Description	Required	Default
logs	string	The logs output from the code interpreter.	Yes
type	enum	The type of the output. Always logs. Possible values: logs	Yes	logs

OpenAI.CodeInterpreterTool

Code interpreter

A tool that runs Python code to help generate a response to a prompt.

Name	Type	Description	Required	Default
container	string or OpenAI.CodeInterpreterContainerAuto	The code interpreter container. Can be a container ID or an object that specifies uploaded file IDs to make available to your code, along with an optional memory_limit setting.	Yes
type	enum	The type of the code interpreter tool. Always code_interpreter. Possible values: code_interpreter	Yes

OpenAI.ComparisonFilter

Comparison Filter

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

Name	Type	Description	Required	Default
key	string	The key to compare against the value.	Yes
type	enum	Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin. - eq: equals - ne: not equal - gt: greater than - gte: greater than or equal - lt: less than - lte: less than or equal - in: in - nin: not in Possible values: eq, ne, gt, gte, lt, lte	Yes	eq
value	string or number or boolean or array of OpenAI.ComparisonFilterValueItems	The value to compare against the attribute key; supports string, number, or boolean types.	Yes

OpenAI.ComparisonFilterValueItems

This schema accepts one of the following types:

• string
• number

OpenAI.CompoundFilter

Compound Filter

Combine multiple filters using and or or.

Name	Type	Description	Required	Default
filters	array of OpenAI.ComparisonFilter or object	Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.	Yes
type	enum	Type of operation: and or or. Possible values: and, or	Yes

OpenAI.ComputerAction

Discriminator for OpenAI.ComputerAction

This component uses the property type to discriminate between different types:

Type Value	Schema
click	OpenAI.ClickParam
double_click	OpenAI.DoubleClickAction
drag	OpenAI.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.Screenshot
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI.Wait

Name	Type	Description	Required	Default
type	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionType

Property	Value
Type	string
Values	click double_click drag keypress move screenshot scroll type wait

OpenAI.ComputerCallSafetyCheckParam

A pending safety check for the computer call.

Name	Type	Description	Required	Default
code	string or null		No
id	string	The ID of the pending safety check.	Yes
message	string or null		No

OpenAI.ComputerEnvironment

Property	Value
Type	string
Values	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotImage

A computer screenshot image used with the computer use tool.

Name	Type	Description	Required	Default
file_id	string	The identifier of an uploaded file that contains the screenshot.	No
image_url	string (uri)	The URL of the screenshot image.	No
type	enum	Specifies the event type. For a computer screenshot, this property is always set to computer_screenshot. Possible values: computer_screenshot	Yes	computer_screenshot

OpenAI.ComputerUsePreviewTool

Computer use preview

A tool that controls a virtual computer.

Name	Type	Description	Required	Default
display_height	integer	The height of the computer display.	Yes
display_width	integer	The width of the computer display.	Yes
environment	OpenAI.ComputerEnvironment		Yes
type	enum	The type of the computer use tool. Always computer_use_preview. Possible values: computer_use_preview	Yes	computer_use_preview

OpenAI.ContainerFileCitationBody

Container file citation

A citation for a container file used to generate a model response.

Name	Type	Description	Required	Default
container_id	string	The ID of the container file.	Yes
end_index	integer	The index of the last character of the container file citation in the message.	Yes
file_id	string	The ID of the file.	Yes
filename	string	The filename of the container file cited.	Yes
start_index	integer	The index of the first character of the container file citation in the message.	Yes
type	enum	The type of the container file citation. Always container_file_citation. Possible values: container_file_citation	Yes	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Value
Type	string
Values	1g 4g 16g 64g

OpenAI.ConversationParam

The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.

Type: string or OpenAI.ConversationParam-2

The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.

OpenAI.ConversationParam-2

Conversation object

The conversation that this response belongs to.

Name	Type	Description	Required	Default
id	string	The unique ID of the conversation.	Yes

OpenAI.ConversationReference

Conversation

The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation.

Name	Type	Description	Required	Default
id	string	The unique ID of the conversation that this response was associated with.	Yes

OpenAI.CreateResponse

Name	Type	Description	Required	Default
background	boolean or null		No
conversation	OpenAI.ConversationParam or null		No
include	array of OpenAI.IncludeEnum or null		No
input	OpenAI.InputParam	Text, image, or file inputs to the model, used to generate a response. Learn more: - Text inputs and outputs - Image inputs - File inputs - Conversation state - Function calling	No
instructions	string or null		No
max_output_tokens	integer or null		No
max_tool_calls	integer or null		No
metadata	OpenAI.Metadata or null		No
model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
parallel_tool_calls	boolean or null		No
previous_response_id	string or null		No
prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
prompt_cache_retention	string or null		No
reasoning	OpenAI.Reasoning or null		No
safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
store	boolean or null		No
stream	boolean or null		No
stream_options	OpenAI.ResponseStreamOptions or null		No
temperature	number or null		No
text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. The two categories of tools you can provide the model are: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like file search. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code.	No
top_logprobs	integer or null		No
top_p	number or null		No
truncation	string or null		No
user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No

OpenAI.CustomGrammarFormatParam

Grammar format

A grammar defined by the user.

Name	Type	Description	Required	Default
definition	string	The grammar definition.	Yes
syntax	OpenAI.GrammarSyntax1		Yes
type	enum	Grammar format. Always grammar. Possible values: grammar	Yes	grammar

OpenAI.CustomTextFormatParam

Text format

Unconstrained free-form text.

Name	Type	Description	Required	Default
type	enum	Unconstrained text format. Always text. Possible values: text	Yes	text

OpenAI.CustomToolParam

Custom tool

A custom tool that processes input using a specified format. Learn more about custom tools

Name	Type	Description	Required	Default
description	string	Optional description of the custom tool, used to provide more context.	No
format	OpenAI.CustomToolParamFormat	The input format for the custom tool. Default is unconstrained text.	No
└─ type	OpenAI.CustomToolParamFormatType		Yes
name	string	The name of the custom tool, used to identify it in tool calls.	Yes
type	enum	The type of the custom tool. Always custom. Possible values: custom	Yes	custom

OpenAI.CustomToolParamFormat

The input format for the custom tool. Default is unconstrained text.

Discriminator for OpenAI.CustomToolParamFormat

This component uses the property type to discriminate between different types:

Type Value	Schema
text	OpenAI.CustomTextFormatParam
grammar	OpenAI.CustomGrammarFormatParam

Name	Type	Description	Required	Default
type	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Property	Value
Type	string
Values	text grammar

OpenAI.DoubleClickAction

DoubleClick

A double click action.

Name	Type	Description	Required	Default
type	enum	Specifies the event type. For a double click action, this property is always set to double_click. Possible values: double_click	Yes	double_click
x	integer	The x-coordinate where the double click occurred.	Yes
y	integer	The y-coordinate where the double click occurred.	Yes

OpenAI.Drag

Drag

A drag action.

Name	Type	Description	Required	Default
path	array of OpenAI.DragPoint	An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>	Yes
type	enum	Specifies the event type. For a drag action, this property is always set to drag. Possible values: drag	Yes	drag

OpenAI.DragPoint

Coordinate

An x/y coordinate pair, e.g. { x: 100, y: 200 }.

Name	Type	Description	Required	Default
x	integer	The x-coordinate.	Yes
y	integer	The y-coordinate.	Yes

OpenAI.EasyInputMessage

Input message

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Name	Type	Description	Required	Default
content	string or OpenAI.InputMessageContentList	Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.	Yes
role	enum	The role of the message input. One of user, assistant, system, or developer. Possible values: user, assistant, system, developer	Yes
type	enum	The type of the message input. Always message. Possible values: message	Yes

OpenAI.FileCitationBody

File citation

A citation to a file.

Name	Type	Description	Required	Default
file_id	string	The ID of the file.	Yes
filename	string	The filename of the file cited.	Yes
index	integer	The index of the file in the list of files.	Yes
type	enum	The type of the file citation. Always file_citation. Possible values: file_citation	Yes	file_citation

OpenAI.FilePath

File path

A path to a file.

Name	Type	Description	Required	Default
file_id	string	The ID of the file.	Yes
index	integer	The index of the file in the list of files.	Yes
type	enum	The type of the file path. Always file_path. Possible values: file_path	Yes

OpenAI.FileSearchTool

File search

A tool that searches for relevant content from uploaded files.

Name	Type	Description	Required	Default
filters	OpenAI.Filters or null		No
max_num_results	integer	The maximum number of results to return. This number should be between 1 and 50 inclusive.	No
ranking_options	OpenAI.RankingOptions		No
└─ hybrid_search	OpenAI.HybridSearchOptions	Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.	No
└─ ranker	OpenAI.RankerVersionType	The ranker to use for the file search.	No
└─ score_threshold	number	The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.	No
type	enum	The type of the file search tool. Always file_search. Possible values: file_search	Yes	file_search
vector_store_ids	array of string	The IDs of the vector stores to search.	Yes

OpenAI.FileSearchToolCallResults

Name	Type	Description	Required	Default
attributes	OpenAI.VectorStoreFileAttributes or null		No
file_id	string		No
filename	string		No
score	number (float)		No
text	string		No

OpenAI.Filters

Type: OpenAI.ComparisonFilter or OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Discriminator for OpenAI.FunctionAndCustomToolCallOutput

This component uses the property type to discriminate between different types:

Type Value	Schema
input_text	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Type	Description	Required	Default
type	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Input file

A file input to the model.

Name	Type	Description	Required	Default
file_data	string	The content of the file to be sent to the model.	No
file_id	string or null		No
file_url	string (uri)	The URL of the file to be sent to the model.	No
filename	string	The name of the file to be sent to the model.	No
type	enum	The type of the input item. Always input_file. Possible values: input_file	Yes	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Input image

An image input to the model. Learn about image inputs.

Name	Type	Description	Required	Default
detail	OpenAI.ImageDetail		Yes
file_id	string or null		No
image_url	string or null		No
type	enum	The type of the input item. Always input_image. Possible values: input_image	Yes	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Input text

A text input to the model.

Name	Type	Description	Required	Default
text	string	The text input to the model.	Yes
type	enum	The type of the input item. Always input_text. Possible values: input_text	Yes	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Property	Value
Type	string
Values	input_text input_image input_file

OpenAI.FunctionShellAction

Shell exec action

Execute a shell command.

Name	Type	Description	Required	Default
commands	array of string		Yes
max_output_length	integer or null		Yes
timeout_ms	integer or null		Yes

OpenAI.FunctionShellCallOutputContent

Shell call output content

The content of a shell tool call output that was emitted.

Name	Type	Description	Required	Default
created_by	string	The identifier of the actor that created the item.	No
outcome	OpenAI.FunctionShellCallOutputOutcome	Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.	Yes
└─ type	OpenAI.FunctionShellCallOutputOutcomeType		Yes
stderr	string	The standard error output that was captured.	Yes
stdout	string	The standard output that was captured.	Yes

OpenAI.FunctionShellCallOutputExitOutcome

Shell call exit outcome

Indicates that the shell commands finished and returned an exit code.

Name	Type	Description	Required	Default
exit_code	integer	Exit code from the shell process.	Yes
type	enum	The outcome type. Always exit. Possible values: exit	Yes	exit

OpenAI.FunctionShellCallOutputOutcome

Shell call outcome

Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.

Discriminator for OpenAI.FunctionShellCallOutputOutcome

This component uses the property type to discriminate between different types:

Type Value	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcome
exit	OpenAI.FunctionShellCallOutputExitOutcome

Name	Type	Description	Required	Default
type	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeType

Property	Value
Type	string
Values	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Shell call timeout outcome

Indicates that the shell call exceeded its configured time limit.

Name	Type	Description	Required	Default
type	enum	The outcome type. Always timeout. Possible values: timeout	Yes	timeout

OpenAI.FunctionShellToolParam

Shell tool

A tool that allows the model to execute shell commands.

Name	Type	Description	Required	Default
type	enum	The type of the shell tool. Always shell. Possible values: shell	Yes	shell

OpenAI.FunctionTool

Function

Defines a function in your own code the model can choose to call.

Name	Type	Description	Required	Default
description	string or null		No
name	string	The name of the function to call.	Yes
parameters	object or null		Yes
strict	boolean or null		Yes
type	enum	The type of the function tool. Always function. Possible values: function	Yes	function

OpenAI.GrammarSyntax1

Property	Value
Type	string
Values	lark regex

OpenAI.HybridSearchOptions

Name	Type	Description	Required	Default
embedding_weight	number	The weight of the embedding in the reciprocal ranking fusion.	Yes
text_weight	number	The weight of the text in the reciprocal ranking fusion.	Yes

OpenAI.ImageDetail

Property	Value
Type	string
Values	low high auto

OpenAI.ImageGenTool

Image generation tool

A tool that generates images using the GPT image models.

Valid models:

gpt-image-1
gpt-image-1-mini

Name	Type	Description	Required	Default
background	enum	Background type for the generated image. One of transparent, opaque, or auto. Default: auto. Possible values: transparent, opaque, auto	No	auto
input_fidelity	OpenAI.InputFidelity or null		No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└─ file_id	string		No
└─ image_url	string		No
model	string (see valid models below)		No
moderation	enum	Moderation level for the generated image. Default: auto. Possible values: auto, low	No	auto
output_compression	integer	Compression level for the output image. Default: 100. Constraints: min: 0, max: 100	No	100
output_format	enum	The output format of the generated image. One of png, webp, or jpeg. Default: png. Possible values: png, webp, jpeg	No	png
partial_images	integer	Number of partial images to generate in streaming mode, from 0 (default value) to 3. Constraints: min: 0, max: 3	No
quality	enum	The quality of the generated image. One of low, medium, high, or auto. Default: auto. Possible values: low, medium, high, auto	No	auto
size	enum	The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto. Possible values: 1024x1024, 1024x1536, 1536x1024, auto	No	auto
type	enum	The type of the image generation tool. Always image_generation. Possible values: image_generation	Yes	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Type	Description	Required	Default
file_id	string		No
image_url	string		No

OpenAI.IncludeEnum

Specify additional output data to include in the model response. Currently supported values are:

• web_search_call.action.sources: Include the sources of the web search tool call.
• code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
• computer_call_output.output.image_url: Include image urls from the computer call output.
• file_search_call.results: Include the search results of the file search tool call.
• message.input_image.image_url: Include image urls from the input message.
• message.output_text.logprobs: Include logprobs with assistant messages.
• reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).

Property	Value
Description	Specify additional output data to include in the model response. Currently supported values are: - web_search_call.action.sources: Include the sources of the web search tool call. - code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items. - computer_call_output.output.image_url: Include image urls from the computer call output. - file_search_call.results: Include the search results of the file search tool call. - message.input_image.image_url: Include image urls from the input message. - message.output_text.logprobs: Include logprobs with assistant messages. - reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).
Type	string
Values	file_search_call.results web_search_call.results web_search_call.action.sources message.input_image.image_url computer_call_output.output.image_url code_interpreter_call.outputs reasoning.encrypted_content message.output_text.logprobs

OpenAI.InputContent

Discriminator for OpenAI.InputContent

This component uses the property type to discriminate between different types:

Type Value	Schema
input_text	OpenAI.InputContentInputTextContent
input_image	OpenAI.InputContentInputImageContent
input_file	OpenAI.InputContentInputFileContent

Name	Type	Description	Required	Default
type	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

Input file

A file input to the model.

Name	Type	Description	Required	Default
file_data	string	The content of the file to be sent to the model.	No
file_id	string or null		No
file_url	string (uri)	The URL of the file to be sent to the model.	No
filename	string	The name of the file to be sent to the model.	No
type	enum	The type of the input item. Always input_file. Possible values: input_file	Yes	input_file

OpenAI.InputContentInputImageContent

Input image

An image input to the model. Learn about image inputs.

Name	Type	Description	Required	Default
detail	OpenAI.ImageDetail		Yes
file_id	string or null		No
image_url	string or null		No
type	enum	The type of the input item. Always input_image. Possible values: input_image	Yes	input_image

OpenAI.InputContentInputTextContent

Input text

A text input to the model.

Name	Type	Description	Required	Default
text	string	The text input to the model.	Yes
type	enum	The type of the input item. Always input_text. Possible values: input_text	Yes	input_text

OpenAI.InputContentType

Property	Value
Type	string
Values	input_text input_image input_file

OpenAI.InputFidelity

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. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

Property	Value
Type	string
Values	high low

OpenAI.InputFileContent

Input file

A file input to the model.

Name	Type	Description	Required	Default
file_data	string	The content of the file to be sent to the model.	No
file_id	string or null		No
file_url	string (uri)	The URL of the file to be sent to the model.	No
filename	string	The name of the file to be sent to the model.	No
type	enum	The type of the input item. Always input_file. Possible values: input_file	Yes	input_file

OpenAI.InputImageContent

Input image

An image input to the model. Learn about image inputs.

Name	Type	Description	Required	Default
detail	OpenAI.ImageDetail		Yes
file_id	string or null		No
image_url	string or null		No
type	enum	The type of the input item. Always input_image. Possible values: input_image	Yes	input_image

OpenAI.InputItem

Discriminator for OpenAI.InputItem

This component uses the property type to discriminate between different types:

Type Value	Schema
message	OpenAI.EasyInputMessage
item_reference	OpenAI.ItemReferenceParam

Name	Type	Description	Required	Default
type	OpenAI.InputItemType		Yes

OpenAI.InputItemType

Property	Value
Type	string
Values	message item_reference

OpenAI.InputMessageContentList

Input item content list

A list of one or many input items to the model, containing different content types.

Array of: OpenAI.InputContent

OpenAI.InputMessageResource

Name	Type	Description	Required	Default
content	OpenAI.InputMessageContentList	A list of one or many input items to the model, containing different content types.	Yes
id	string	The unique ID of the message input.	Yes
role	enum	The role of the message input. One of user, system, or developer. Possible values: user, system, developer	Yes
status	enum	The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API. Possible values: in_progress, completed, incomplete	No
type	enum	The type of the message input. Always set to message. Possible values: message	Yes

OpenAI.InputParam

Text, image, or file inputs to the model, used to generate a response. Learn more:

• Text inputs and outputs
• Image inputs
• File inputs
• Conversation state
• Function calling

Type: string or array of OpenAI.InputItem

Text, image, or file inputs to the model, used to generate a response. Learn more:

• Text inputs and outputs
• Image inputs
• File inputs
• Conversation state
• Function calling

OpenAI.InputTextContent

Input text

A text input to the model.

Name	Type	Description	Required	Default
text	string	The text input to the model.	Yes
type	enum	The type of the input item. Always input_text. Possible values: input_text	Yes	input_text

OpenAI.ItemReferenceParam

Item reference

An internal identifier for an item to reference.

Name	Type	Description	Required	Default
id	string	The ID of the item to reference.	Yes
type	enum	The type of item to reference. Always item_reference. Possible values: item_reference	Yes	item_reference

OpenAI.ItemResource

Content item used to generate a response.

Discriminator for OpenAI.ItemResource

This component uses the property type to discriminate between different types:

Type Value	Schema
message	OpenAI.InputMessageResource
output_message	OpenAI.ItemResourceOutputMessage
file_search_call	OpenAI.ItemResourceFileSearchToolCall
computer_call	OpenAI.ItemResourceComputerToolCall
computer_call_output	OpenAI.ItemResourceComputerToolCallOutputResource
web_search_call	OpenAI.ItemResourceWebSearchToolCall
function_call	OpenAI.ItemResourceFunctionToolCallResource
function_call_output	OpenAI.ItemResourceFunctionToolCallOutputResource
image_generation_call	OpenAI.ItemResourceImageGenToolCall
code_interpreter_call	OpenAI.ItemResourceCodeInterpreterToolCall
local_shell_call	OpenAI.ItemResourceLocalShellToolCall
local_shell_call_output	OpenAI.ItemResourceLocalShellToolCallOutput
shell_call	OpenAI.ItemResourceFunctionShellCall
shell_call_output	OpenAI.ItemResourceFunctionShellCallOutput
apply_patch_call	OpenAI.ItemResourceApplyPatchToolCall
apply_patch_call_output	OpenAI.ItemResourceApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ItemResourceMcpListTools
mcp_approval_request	OpenAI.ItemResourceMcpApprovalRequest
mcp_approval_response	OpenAI.ItemResourceMcpApprovalResponseResource
mcp_call	OpenAI.ItemResourceMcpToolCall

Name	Type	Description	Required	Default
type	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

Apply patch tool call

A tool call that applies file diffs by creating, deleting, or updating files.

Name	Type	Description	Required	Default
call_id	string	The unique ID of the apply patch tool call generated by the model.	Yes
created_by	string	The ID of the entity that created this tool call.	No
id	string	The unique ID of the apply patch tool call. Populated when this item is returned via API.	Yes
operation	OpenAI.ApplyPatchFileOperation	One of the create_file, delete_file, or update_file operations applied via apply_patch.	Yes
└─ type	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
type	enum	The type of the item. Always apply_patch_call. Possible values: apply_patch_call	Yes	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Apply patch tool call output

The output emitted by an apply patch tool call.

Name	Type	Description	Required	Default
call_id	string	The unique ID of the apply patch tool call generated by the model.	Yes
created_by	string	The ID of the entity that created this tool call output.	No
id	string	The unique ID of the apply patch tool call output. Populated when this item is returned via API.	Yes
output	string or null		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	The type of the item. Always apply_patch_call_output. Possible values: apply_patch_call_output	Yes	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Code interpreter tool call

A tool call to run code.

Name	Type	Description	Required	Default
code	string or null		Yes
container_id	string	The ID of the container used to run the code.	Yes
id	string	The unique ID of the code interpreter tool call.	Yes
outputs	array of OpenAI.CodeInterpreterOutputLogs or OpenAI.CodeInterpreterOutputImage or null		Yes
status	enum	The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed. Possible values: in_progress, completed, incomplete, interpreting, failed	Yes
type	enum	The type of the code interpreter tool call. Always code_interpreter_call. Possible values: code_interpreter_call	Yes	code_interpreter_call

OpenAI.ItemResourceComputerToolCall

Computer tool call

A tool call to a computer use tool. See the computer use guide for more information.

Name	Type	Description	Required	Default
action	OpenAI.ComputerAction		Yes
call_id	string	An identifier used when responding to the tool call with output.	Yes
id	string	The unique ID of the computer call.	Yes
pending_safety_checks	array of OpenAI.ComputerCallSafetyCheckParam	The pending safety checks for the computer call.	Yes
status	enum	The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API. Possible values: in_progress, completed, incomplete	Yes
type	enum	The type of the computer call. Always computer_call. Possible values: computer_call	Yes	computer_call

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Type	Description	Required	Default
acknowledged_safety_checks	array of OpenAI.ComputerCallSafetyCheckParam	The safety checks reported by the API that have been acknowledged by the developer.	No
call_id	string	The ID of the computer tool call that produced the output.	Yes
id	string	The ID of the computer tool call output.	No
output	OpenAI.ComputerScreenshotImage	A computer screenshot image used with the computer use tool.	Yes
status	enum	The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API. Possible values: in_progress, completed, incomplete	No
type	enum	The type of the computer tool call output. Always computer_call_output. Possible values: computer_call_output	Yes	computer_call_output

OpenAI.ItemResourceFileSearchToolCall

File search tool call

The results of a file search tool call. See the file search guide for more information.

Name	Type	Description	Required	Default
id	string	The unique ID of the file search tool call.	Yes
queries	array of string	The queries used to search for files.	Yes
results	array of OpenAI.FileSearchToolCallResults or null		No
status	enum	The status of the file search tool call. One of in_progress, searching, incomplete or failed, Possible values: in_progress, searching, completed, incomplete, failed	Yes
type	enum	The type of the file search tool call. Always file_search_call. Possible values: file_search_call	Yes

OpenAI.ItemResourceFunctionShellCall

Shell tool call

A tool call that executes one or more shell commands in a managed environment.

Name	Type	Description	Required	Default
action	OpenAI.FunctionShellAction	Execute a shell command.	Yes
└─ commands	array of string		Yes
└─ max_output_length	integer or null		Yes
└─ timeout_ms	integer or null		Yes
call_id	string	The unique ID of the shell tool call generated by the model.	Yes
created_by	string	The ID of the entity that created this tool call.	No
id	string	The unique ID of the shell tool call. Populated when this item is returned via API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
type	enum	The type of the item. Always shell_call. Possible values: shell_call	Yes	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Shell call output

The output of a shell tool call that was emitted.

Name	Type	Description	Required	Default
call_id	string	The unique ID of the shell tool call generated by the model.	Yes
created_by	string	The identifier of the actor that created the item.	No
id	string	The unique ID of the shell call output. Populated when this item is returned via API.	Yes
max_output_length	integer or null		Yes
output	array of OpenAI.FunctionShellCallOutputContent	An array of shell call output contents	Yes
type	enum	The type of the shell call output. Always shell_call_output. Possible values: shell_call_output	Yes	shell_call_output

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Type	Description	Required	Default
call_id	string	The unique ID of the function tool call generated by the model.	Yes
id	string	The unique ID of the function tool call output. Populated when this item is returned via API.	No
output	string or array of OpenAI.FunctionAndCustomToolCallOutput	The output from the function call generated by your code. Can be a string or an list of output content.	Yes
status	enum	The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API. Possible values: in_progress, completed, incomplete	No
type	enum	The type of the function tool call output. Always function_call_output. Possible values: function_call_output	Yes

OpenAI.ItemResourceFunctionToolCallResource

Name	Type	Description	Required	Default
arguments	string	A JSON string of the arguments to pass to the function.	Yes
call_id	string	The unique ID of the function tool call generated by the model.	Yes
id	string	The unique ID of the function tool call.	No
name	string	The name of the function to run.	Yes
status	enum	The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API. Possible values: in_progress, completed, incomplete	No
type	enum	The type of the function tool call. Always function_call. Possible values: function_call	Yes

OpenAI.ItemResourceImageGenToolCall

Image generation call

An image generation request made by the model.

Name	Type	Description	Required	Default
id	string	The unique ID of the image generation call.	Yes
result	string or null		Yes
status	enum	The status of the image generation call. Possible values: in_progress, completed, generating, failed	Yes
type	enum	The type of the image generation call. Always image_generation_call. Possible values: image_generation_call	Yes

OpenAI.ItemResourceLocalShellToolCall

Local shell call

A tool call to run a command on the local shell.

Name	Type	Description	Required	Default
action	OpenAI.LocalShellExecAction	Execute a shell command on the server.	Yes
call_id	string	The unique ID of the local shell tool call generated by the model.	Yes
id	string	The unique ID of the local shell call.	Yes
status	enum	The status of the local shell call. Possible values: in_progress, completed, incomplete	Yes
type	enum	The type of the local shell call. Always local_shell_call. Possible values: local_shell_call	Yes

OpenAI.ItemResourceLocalShellToolCallOutput

Local shell call output

The output of a local shell tool call.

Name	Type	Description	Required	Default
id	string	The unique ID of the local shell tool call generated by the model.	Yes
output	string	A JSON string of the output of the local shell tool call.	Yes
status	string or null		No
type	enum	The type of the local shell tool call output. Always local_shell_call_output. Possible values: local_shell_call_output	Yes

OpenAI.ItemResourceMcpApprovalRequest

MCP approval request

A request for human approval of a tool invocation.

Name	Type	Description	Required	Default
arguments	string	A JSON string of arguments for the tool.	Yes
id	string	The unique ID of the approval request.	Yes
name	string	The name of the tool to run.	Yes
server_label	string	The label of the MCP server making the request.	Yes
type	enum	The type of the item. Always mcp_approval_request. Possible values: mcp_approval_request	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

MCP approval response

A response to an MCP approval request.

Name	Type	Description	Required	Default
approval_request_id	string	The ID of the approval request being answered.	Yes
approve	boolean	Whether the request was approved.	Yes
id	string	The unique ID of the approval response	Yes
reason	string or null		No
type	enum	The type of the item. Always mcp_approval_response. Possible values: mcp_approval_response	Yes

OpenAI.ItemResourceMcpListTools

MCP list tools

A list of tools available on an MCP server.

Name	Type	Description	Required	Default
error	string or null		No
id	string	The unique ID of the list.	Yes
server_label	string	The label of the MCP server.	Yes
tools	array of OpenAI.MCPListToolsTool	The tools available on the server.	Yes
type	enum	The type of the item. Always mcp_list_tools. Possible values: mcp_list_tools	Yes

OpenAI.ItemResourceMcpToolCall

MCP tool call

An invocation of a tool on an MCP server.

Name	Type	Description	Required	Default
approval_request_id	string or null		No
arguments	string	A JSON string of the arguments passed to the tool.	Yes
error	string or null		No
id	string	The unique ID of the tool call.	Yes
name	string	The name of the tool that was run.	Yes
output	string or null		No
server_label	string	The label of the MCP server running the tool.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	The type of the item. Always mcp_call. Possible values: mcp_call	Yes

OpenAI.ItemResourceOutputMessage

Output message

An output message from the model.

Name	Type	Description	Required	Default
content	array of OpenAI.OutputMessageContent	The content of the output message.	Yes
id	string	The unique ID of the output message.	Yes
role	enum	The role of the output message. Always assistant. Possible values: assistant	Yes
status	enum	The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API. Possible values: in_progress, completed, incomplete	Yes
type	enum	The type of the output message. Always message. Possible values: output_message	Yes

OpenAI.ItemResourceType

Property	Value
Type	string
Values	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output image_generation_call code_interpreter_call local_shell_call local_shell_call_output shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call

OpenAI.ItemResourceWebSearchToolCall

Web search tool call

The results of a web search tool call. See the web search guide for more information.

Name	Type	Description	Required	Default
action	OpenAI.WebSearchActionSearch or OpenAI.WebSearchActionOpenPage or OpenAI.WebSearchActionFind	An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find).	Yes
id	string	The unique ID of the web search tool call.	Yes
status	enum	The status of the web search tool call. Possible values: in_progress, searching, completed, failed	Yes
type	enum	The type of the web search tool call. Always web_search_call. Possible values: web_search_call	Yes

OpenAI.KeyPressAction

KeyPress

A collection of keypresses the model would like to perform.

Name	Type	Description	Required	Default
keys	array of string	The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.	Yes
type	enum	Specifies the event type. For a keypress action, this property is always set to keypress. Possible values: keypress	Yes	keypress

OpenAI.LocalShellCallStatus

Property	Value
Type	string
Values	in_progress completed incomplete

OpenAI.LocalShellExecAction

Local shell exec action

Execute a shell command on the server.

Name	Type	Description	Required	Default
command	array of string	The command to run.	Yes
env	object	Environment variables to set for the command.	Yes
timeout_ms	integer or null		No
type	enum	The type of the local shell action. Always exec. Possible values: exec	Yes	exec
user	string or null		No
working_directory	string or null		No

OpenAI.LocalShellToolParam

Local shell tool

A tool that allows the model to execute shell commands in a local environment.

Name	Type	Description	Required	Default
type	enum	The type of the local shell tool. Always local_shell. Possible values: local_shell	Yes	local_shell

OpenAI.LogProb

Log probability

The log probability of a token.

Name	Type	Description	Required	Default
bytes	array of integer		Yes
logprob	number		Yes
token	string		Yes
top_logprobs	array of OpenAI.TopLogProb		Yes

OpenAI.MCPListToolsTool

MCP list tools tool

A tool available on an MCP server.

Name	Type	Description	Required	Default
annotations	OpenAI.MCPListToolsToolAnnotations or null		No
description	string or null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Yes
name	string	The name of the tool.	Yes

OpenAI.MCPListToolsToolAnnotations

Type: object

OpenAI.MCPListToolsToolInputSchema

Type: object

OpenAI.MCPTool

MCP tool

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

Name	Type	Description	Required	Default
allowed_tools	array of string or OpenAI.MCPToolFilter or null		No
authorization	string	An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.	No
connector_id	enum	Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here. Currently supported connector_id values are: - Dropbox: connector_dropbox - Gmail: connector_gmail - Google Calendar: connector_googlecalendar - Google Drive: connector_googledrive - Microsoft Teams: connector_microsoftteams - Outlook Calendar: connector_outlookcalendar - Outlook Email: connector_outlookemail - SharePoint: connector_sharepoint Possible values: connector_dropbox, connector_gmail, connector_googlecalendar, connector_googledrive, connector_microsoftteams, connector_outlookcalendar, connector_outlookemail, connector_sharepoint	No
headers	object or null		No
require_approval	OpenAI.MCPToolRequireApproval or string or null		No
server_description	string	Optional description of the MCP server, used to provide more context.	No
server_label	string	A label for this MCP server, used to identify it in tool calls.	Yes
server_url	string (uri)	The URL for the MCP server. One of server_url or connector_id must be provided.	No
type	enum	The type of the MCP tool. Always mcp. Possible values: mcp	Yes

OpenAI.MCPToolCallStatus

Property	Value
Type	string
Values	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

MCP tool filter

A filter object to specify which tools are allowed.

Name	Type	Description	Required	Default
read_only	boolean	Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.	No
tool_names	array of string	List of allowed tool names.	No

OpenAI.MCPToolRequireApproval

Name	Type	Description	Required	Default
always	OpenAI.MCPToolFilter	A filter object to specify which tools are allowed.	No
never	OpenAI.MCPToolFilter	A filter object to specify which tools are allowed.	No

OpenAI.Metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Type: object

OpenAI.Move

Move

A mouse move action.

Name	Type	Description	Required	Default
type	enum	Specifies the event type. For a move action, this property is always set to move. Possible values: move	Yes	move
x	integer	The x-coordinate to move to.	Yes
y	integer	The y-coordinate to move to.	Yes

OpenAI.OutputContent

Discriminator for OpenAI.OutputContent

This component uses the property type to discriminate between different types:

Type Value	Schema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent

Name	Type	Description	Required	Default
type	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

Output text

A text output from the model.

Name	Type	Description	Required	Default
annotations	array of OpenAI.Annotation	The annotations of the text output.	Yes
logprobs	array of OpenAI.LogProb		No
text	string	The text output from the model.	Yes
type	enum	The type of the output text. Always output_text. Possible values: output_text	Yes	output_text

OpenAI.OutputContentRefusalContent

Refusal

A refusal from the model.

Name	Type	Description	Required	Default
refusal	string	The refusal explanation from the model.	Yes
type	enum	The type of the refusal. Always refusal. Possible values: refusal	Yes	refusal

OpenAI.OutputContentType

Property	Value
Type	string
Values	output_text refusal reasoning_text

OpenAI.OutputItem

Discriminator for OpenAI.OutputItem

This component uses the property type to discriminate between different types:

Type Value	Schema
output_message	OpenAI.OutputItemOutputMessage
file_search_call	OpenAI.OutputItemFileSearchToolCall
function_call	OpenAI.OutputItemFunctionToolCall
web_search_call	OpenAI.OutputItemWebSearchToolCall
computer_call	OpenAI.OutputItemComputerToolCall
reasoning	OpenAI.OutputItemReasoningItem
compaction	OpenAI.OutputItemCompactionBody
image_generation_call	OpenAI.OutputItemImageGenToolCall
code_interpreter_call	OpenAI.OutputItemCodeInterpreterToolCall
local_shell_call	OpenAI.OutputItemLocalShellToolCall
shell_call	OpenAI.OutputItemFunctionShellCall
shell_call_output	OpenAI.OutputItemFunctionShellCallOutput
apply_patch_call	OpenAI.OutputItemApplyPatchToolCall
apply_patch_call_output	OpenAI.OutputItemApplyPatchToolCallOutput
mcp_call	OpenAI.OutputItemMcpToolCall
mcp_list_tools	OpenAI.OutputItemMcpListTools
mcp_approval_request	OpenAI.OutputItemMcpApprovalRequest
custom_tool_call	OpenAI.OutputItemCustomToolCall

Name	Type	Description	Required	Default
type	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

Apply patch tool call

A tool call that applies file diffs by creating, deleting, or updating files.

Name	Type	Description	Required	Default
call_id	string	The unique ID of the apply patch tool call generated by the model.	Yes
created_by	string	The ID of the entity that created this tool call.	No
id	string	The unique ID of the apply patch tool call. Populated when this item is returned via API.	Yes
operation	OpenAI.ApplyPatchFileOperation	One of the create_file, delete_file, or update_file operations applied via apply_patch.	Yes
└─ type	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
type	enum	The type of the item. Always apply_patch_call. Possible values: apply_patch_call	Yes	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Apply patch tool call output

The output emitted by an apply patch tool call.

Name	Type	Description	Required	Default
call_id	string	The unique ID of the apply patch tool call generated by the model.	Yes
created_by	string	The ID of the entity that created this tool call output.	No
id	string	The unique ID of the apply patch tool call output. Populated when this item is returned via API.	Yes
output	string or null		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	The type of the item. Always apply_patch_call_output. Possible values: apply_patch_call_output	Yes	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Code interpreter tool call

A tool call to run code.

Name	Type	Description	Required	Default
code	string or null		Yes
container_id	string	The ID of the container used to run the code.	Yes
id	string	The unique ID of the code interpreter tool call.	Yes
outputs	array of OpenAI.CodeInterpreterOutputLogs or OpenAI.CodeInterpreterOutputImage or null		Yes
status	enum	The status of the code interpreter tool call. Valid values are in_progress, completed, incomplete, interpreting, and failed. Possible values: in_progress, completed, incomplete, interpreting, failed	Yes
type	enum	The type of the code interpreter tool call. Always code_interpreter_call. Possible values: code_interpreter_call	Yes	code_interpreter_call

OpenAI.OutputItemCompactionBody

Compaction item

A compaction item generated by the v1/responses/compact API.

Name	Type	Description	Required	Default
created_by	string	The identifier of the actor that created the item.	No
encrypted_content	string	The encrypted content that was produced by compaction.	Yes
id	string	The unique ID of the compaction item.	Yes
type	enum	The type of the item. Always compaction. Possible values: compaction	Yes	compaction

OpenAI.OutputItemComputerToolCall

Computer tool call

A tool call to a computer use tool. See the computer use guide for more information.

Name	Type	Description	Required	Default
action	OpenAI.ComputerAction		Yes
call_id	string	An identifier used when responding to the tool call with output.	Yes
id	string	The unique ID of the computer call.	Yes
pending_safety_checks	array of OpenAI.ComputerCallSafetyCheckParam	The pending safety checks for the computer call.	Yes
status	enum	The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API. Possible values: in_progress, completed, incomplete	Yes
type	enum	The type of the computer call. Always computer_call. Possible values: computer_call	Yes	computer_call

OpenAI.OutputItemCustomToolCall

Custom tool call

A call to a custom tool created by the model.

Name	Type	Description	Required	Default
call_id	string	An identifier used to map this custom tool call to a tool call output.	Yes
id	string	The unique ID of the custom tool call in the OpenAI platform.	No
input	string	The input for the custom tool call generated by the model.	Yes
name	string	The name of the custom tool being called.	Yes
type	enum	The type of the custom tool call. Always custom_tool_call. Possible values: custom_tool_call	Yes

OpenAI.OutputItemFileSearchToolCall

File search tool call

The results of a file search tool call. See the file search guide for more information.

Name	Type	Description	Required	Default
id	string	The unique ID of the file search tool call.	Yes
queries	array of string	The queries used to search for files.	Yes
results	array of OpenAI.FileSearchToolCallResults or null		No
status	enum	The status of the file search tool call. One of in_progress, searching, incomplete or failed, Possible values: in_progress, searching, completed, incomplete, failed	Yes
type	enum	The type of the file search tool call. Always file_search_call. Possible values: file_search_call	Yes

OpenAI.OutputItemFunctionShellCall

Shell tool call

A tool call that executes one or more shell commands in a managed environment.

Name	Type	Description	Required	Default
action	OpenAI.FunctionShellAction	Execute a shell command.	Yes
└─ commands	array of string		Yes
└─ max_output_length	integer or null		Yes
└─ timeout_ms	integer or null		Yes
call_id	string	The unique ID of the shell tool call generated by the model.	Yes
created_by	string	The ID of the entity that created this tool call.	No
id	string	The unique ID of the shell tool call. Populated when this item is returned via API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
type	enum	The type of the item. Always shell_call. Possible values: shell_call	Yes	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Shell call output

The output of a shell tool call that was emitted.

Name	Type	Description	Required	Default
call_id	string	The unique ID of the shell tool call generated by the model.	Yes
created_by	string	The identifier of the actor that created the item.	No
id	string	The unique ID of the shell call output. Populated when this item is returned via API.	Yes
max_output_length	integer or null		Yes
output	array of OpenAI.FunctionShellCallOutputContent	An array of shell call output contents	Yes
type	enum	The type of the shell call output. Always shell_call_output. Possible values: shell_call_output	Yes	shell_call_output

OpenAI.OutputItemFunctionToolCall

Function tool call

A tool call to run a function. See the function calling guide for more information.

Name	Type	Description	Required	Default
arguments	string	A JSON string of the arguments to pass to the function.	Yes
call_id	string	The unique ID of the function tool call generated by the model.	Yes
id	string	The unique ID of the function tool call.	No
name	string	The name of the function to run.	Yes
status	enum	The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API. Possible values: in_progress, completed, incomplete	No
type	enum	The type of the function tool call. Always function_call. Possible values: function_call	Yes

OpenAI.OutputItemImageGenToolCall

Image generation call

An image generation request made by the model.

Name	Type	Description	Required	Default
id	string	The unique ID of the image generation call.	Yes
result	string or null		Yes
status	enum	The status of the image generation call. Possible values: in_progress, completed, generating, failed	Yes
type	enum	The type of the image generation call. Always image_generation_call. Possible values: image_generation_call	Yes

OpenAI.OutputItemLocalShellToolCall

Local shell call

A tool call to run a command on the local shell.

Name	Type	Description	Required	Default
action	OpenAI.LocalShellExecAction	Execute a shell command on the server.	Yes
call_id	string	The unique ID of the local shell tool call generated by the model.	Yes
id	string	The unique ID of the local shell call.	Yes
status	enum	The status of the local shell call. Possible values: in_progress, completed, incomplete	Yes
type	enum	The type of the local shell call. Always local_shell_call. Possible values: local_shell_call	Yes

OpenAI.OutputItemMcpApprovalRequest

MCP approval request

A request for human approval of a tool invocation.

Name	Type	Description	Required	Default
arguments	string	A JSON string of arguments for the tool.	Yes
id	string	The unique ID of the approval request.	Yes
name	string	The name of the tool to run.	Yes
server_label	string	The label of the MCP server making the request.	Yes
type	enum	The type of the item. Always mcp_approval_request. Possible values: mcp_approval_request	Yes

OpenAI.OutputItemMcpListTools

MCP list tools

A list of tools available on an MCP server.

Name	Type	Description	Required	Default
error	string or null		No
id	string	The unique ID of the list.	Yes
server_label	string	The label of the MCP server.	Yes
tools	array of OpenAI.MCPListToolsTool	The tools available on the server.	Yes
type	enum	The type of the item. Always mcp_list_tools. Possible values: mcp_list_tools	Yes

OpenAI.OutputItemMcpToolCall

MCP tool call

An invocation of a tool on an MCP server.

Name	Type	Description	Required	Default
approval_request_id	string or null		No
arguments	string	A JSON string of the arguments passed to the tool.	Yes
error	string or null		No
id	string	The unique ID of the tool call.	Yes
name	string	The name of the tool that was run.	Yes
output	string or null		No
server_label	string	The label of the MCP server running the tool.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	The type of the item. Always mcp_call. Possible values: mcp_call	Yes

OpenAI.OutputItemOutputMessage

Output message

An output message from the model.

Name	Type	Description	Required	Default
content	array of OpenAI.OutputMessageContent	The content of the output message.	Yes
id	string	The unique ID of the output message.	Yes
role	enum	The role of the output message. Always assistant. Possible values: assistant	Yes
status	enum	The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API. Possible values: in_progress, completed, incomplete	Yes
type	enum	The type of the output message. Always message. Possible values: output_message	Yes

OpenAI.OutputItemReasoningItem

Reasoning

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

Name	Type	Description	Required	Default
content	array of OpenAI.ReasoningTextContent	Reasoning text content.	No
encrypted_content	string or null		No
id	string	The unique identifier of the reasoning content.	Yes
status	enum	The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API. Possible values: in_progress, completed, incomplete	No
summary	array of OpenAI.Summary	Reasoning summary content.	Yes
type	enum	The type of the object. Always reasoning. Possible values: reasoning	Yes

OpenAI.OutputItemType

Property	Value
Type	string
Values	output_message file_search_call function_call web_search_call computer_call reasoning compaction image_generation_call code_interpreter_call local_shell_call shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_call mcp_list_tools mcp_approval_request custom_tool_call

OpenAI.OutputItemWebSearchToolCall

Web search tool call

The results of a web search tool call. See the web search guide for more information.

Name	Type	Description	Required	Default
action	OpenAI.WebSearchActionSearch or OpenAI.WebSearchActionOpenPage or OpenAI.WebSearchActionFind	An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find).	Yes
id	string	The unique ID of the web search tool call.	Yes
status	enum	The status of the web search tool call. Possible values: in_progress, searching, completed, failed	Yes
type	enum	The type of the web search tool call. Always web_search_call. Possible values: web_search_call	Yes

OpenAI.OutputMessageContent

Discriminator for OpenAI.OutputMessageContent

This component uses the property type to discriminate between different types:

Type Value	Schema
output_text	OpenAI.OutputMessageContentOutputTextContent
refusal	OpenAI.OutputMessageContentRefusalContent

Name	Type	Description	Required	Default
type	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

Output text

A text output from the model.

Name	Type	Description	Required	Default
annotations	array of OpenAI.Annotation	The annotations of the text output.	Yes
logprobs	array of OpenAI.LogProb		No
text	string	The text output from the model.	Yes
type	enum	The type of the output text. Always output_text. Possible values: output_text	Yes	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

A refusal from the model.

Name	Type	Description	Required	Default
refusal	string	The refusal explanation from the model.	Yes
type	enum	The type of the refusal. Always refusal. Possible values: refusal	Yes	refusal

OpenAI.OutputMessageContentType

Property	Value
Type	string
Values	output_text refusal

OpenAI.Prompt

Reference to a prompt template and its variables. Learn more.

Name	Type	Description	Required	Default
id	string	The unique identifier of the prompt template to use.	Yes
variables	OpenAI.ResponsePromptVariables or null		No
version	string or null		No

OpenAI.RankerVersionType

Property	Value
Type	string
Values	auto default-2024-11-15

OpenAI.RankingOptions

Name	Type	Description	Required	Default
hybrid_search	OpenAI.HybridSearchOptions		No
└─ embedding_weight	number	The weight of the embedding in the reciprocal ranking fusion.	Yes
└─ text_weight	number	The weight of the text in the reciprocal ranking fusion.	Yes
ranker	OpenAI.RankerVersionType		No
score_threshold	number	The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.	No

OpenAI.Reasoning

Reasoning

gpt-5 and o-series models only Configuration options for reasoning models.

Name	Type	Description	Required	Default
effort	OpenAI.ReasoningEffort	Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1. - All models before gpt-5.1 default to medium reasoning effort, and do not support none. - The gpt-5-pro model defaults to (and only supports) high reasoning effort. - xhigh is supported for all models after gpt-5.1-codex-max.	No
generate_summary	string or null		No
summary	string or null		No

OpenAI.ReasoningEffort

Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1.
• All models before gpt-5.1 default to medium reasoning effort, and do not support none.
• The gpt-5-pro model defaults to (and only supports) high reasoning effort.
• xhigh is supported for all models after gpt-5.1-codex-max.

Property	Value
Description	Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1. - All models before gpt-5.1 default to medium reasoning effort, and do not support none. - The gpt-5-pro model defaults to (and only supports) high reasoning effort. - xhigh is supported for all models after gpt-5.1-codex-max.
Type	string
Values	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

ReasoningTextContent

Reasoning text from the model.

Name	Type	Description	Required	Default
text	string	The reasoning text from the model.	Yes
type	enum	The type of the reasoning text. Always reasoning_text. Possible values: reasoning_text	Yes	reasoning_text

OpenAI.Response

The response object

Name	Type	Description	Required	Default
background	boolean or null		No
completed_at	string or null		No
content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
conversation	OpenAI.ConversationReference or null		No
created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
error	OpenAI.ResponseError or null		Yes
id	string	Unique identifier for this Response.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
instructions	string or array of OpenAI.InputItem or null		Yes
max_output_tokens	integer or null		No
max_tool_calls	integer or null		No
metadata	OpenAI.Metadata or null		No
model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
object	enum	The object type of this resource - always set to response. Possible values: response	Yes
output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
output_text	string or null		No
parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
previous_response_id	string or null		No
prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
prompt_cache_retention	string or null		No
reasoning	OpenAI.Reasoning or null		No
safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
temperature	number or null		No
text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
top_logprobs	integer or null		No
top_p	number or null		No
truncation	string or null		No
usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No

OpenAI.ResponseAudioDeltaEvent

Emitted when there is a partial audio response.

Name	Type	Description	Required	Default
delta	string	A chunk of Base64 encoded response audio bytes. Constraints: encoding: base64	Yes
sequence_number	integer	A sequence number for this chunk of the stream response.	Yes
type	enum	The type of the event. Always response.audio.delta. Possible values: response.audio.delta	Yes

OpenAI.ResponseAudioTranscriptDeltaEvent

Emitted when there is a partial transcript of audio.

Name	Type	Description	Required	Default
delta	string	The partial transcript of the audio response.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.audio.transcript.delta. Possible values: response.audio.transcript.delta	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitted when a partial code snippet is streamed by the code interpreter.

Name	Type	Description	Required	Default
delta	string	The partial code snippet being streamed by the code interpreter.	Yes
item_id	string	The unique identifier of the code interpreter tool call item.	Yes
output_index	integer	The index of the output item in the response for which the code is being streamed.	Yes
sequence_number	integer	The sequence number of this event, used to order streaming events.	Yes
type	enum	The type of the event. Always response.code_interpreter_call_code.delta. Possible values: response.code_interpreter_call_code.delta	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Emitted when a code interpreter call is in progress.

Name	Type	Description	Required	Default
item_id	string	The unique identifier of the code interpreter tool call item.	Yes
output_index	integer	The index of the output item in the response for which the code interpreter call is in progress.	Yes
sequence_number	integer	The sequence number of this event, used to order streaming events.	Yes
type	enum	The type of the event. Always response.code_interpreter_call.in_progress. Possible values: response.code_interpreter_call.in_progress	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Emitted when the code interpreter is actively interpreting the code snippet.

Name	Type	Description	Required	Default
item_id	string	The unique identifier of the code interpreter tool call item.	Yes
output_index	integer	The index of the output item in the response for which the code interpreter is interpreting code.	Yes
sequence_number	integer	The sequence number of this event, used to order streaming events.	Yes
type	enum	The type of the event. Always response.code_interpreter_call.interpreting. Possible values: response.code_interpreter_call.interpreting	Yes

OpenAI.ResponseContentPartAddedEvent

Emitted when a new content part is added.

Name	Type	Description	Required	Default
content_index	integer	The index of the content part that was added.	Yes
item_id	string	The ID of the output item that the content part was added to.	Yes
output_index	integer	The index of the output item that the content part was added to.	Yes
part	OpenAI.OutputContent		Yes
└─ type	OpenAI.OutputContentType		Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.content_part.added. Possible values: response.content_part.added	Yes

OpenAI.ResponseCreatedEvent

An event that is emitted when a response is created.

Name	Type	Description	Required	Default
response	OpenAI.Response		Yes
└─ background	boolean or null		No
└─ completed_at	string or null (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
└─ conversation	OpenAI.ConversationReference or null		No
└─ created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
└─ error	OpenAI.ResponseError or null		Yes
└─ id	string	Unique identifier for this Response.	Yes
└─ incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
└─ instructions	string or array of OpenAI.InputItem or null		Yes
└─ max_output_tokens	integer or null		No
└─ max_tool_calls	integer or null		No
└─ metadata	OpenAI.Metadata or null		No
└─ model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
└─ object	enum	The object type of this resource - always set to response. Possible values: response	Yes
└─ output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
└─ output_text	string or null		No
└─ parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
└─ previous_response_id	string or null		No
└─ prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
└─ prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
└─ prompt_cache_retention	string or null		No
└─ reasoning	OpenAI.Reasoning or null		No
└─ safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
└─ status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
└─ temperature	number or null		No	1
└─ text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
└─ tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
└─ tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
└─ top_logprobs	integer or null		No
└─ top_p	number or null		No	1
└─ truncation	string or null		No	disabled
└─ usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
└─ user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No
sequence_number	integer	The sequence number for this event.	Yes
type	enum	The type of the event. Always response.created. Possible values: response.created	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Event representing a delta (partial update) to the input of a custom tool call.

Name	Type	Description	Required	Default
delta	string	The incremental input data (delta) for the custom tool call.	Yes
item_id	string	Unique identifier for the API item associated with this event.	Yes
output_index	integer	The index of the output this delta applies to.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The event type identifier. Possible values: response.custom_tool_call_input.delta	Yes

OpenAI.ResponseError

An error object returned when the model fails to generate a Response.

Name	Type	Description	Required	Default
code	OpenAI.ResponseErrorCode	The error code for the response.	Yes
message	string	A human-readable description of the error.	Yes

OpenAI.ResponseErrorCode

The error code for the response.

Property	Value
Type	string
Values	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

Emitted when an error occurs.

Name	Type	Description	Required	Default
code	string or null		Yes
message	string	The error message.	Yes
param	string or null		Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always error. Possible values: error	Yes

OpenAI.ResponseFailedEvent

An event that is emitted when a response fails.

Name	Type	Description	Required	Default
response	OpenAI.Response		Yes
└─ background	boolean or null		No
└─ completed_at	string or null (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
└─ conversation	OpenAI.ConversationReference or null		No
└─ created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
└─ error	OpenAI.ResponseError or null		Yes
└─ id	string	Unique identifier for this Response.	Yes
└─ incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
└─ instructions	string or array of OpenAI.InputItem or null		Yes
└─ max_output_tokens	integer or null		No
└─ max_tool_calls	integer or null		No
└─ metadata	OpenAI.Metadata or null		No
└─ model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
└─ object	enum	The object type of this resource - always set to response. Possible values: response	Yes
└─ output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
└─ output_text	string or null		No
└─ parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
└─ previous_response_id	string or null		No
└─ prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
└─ prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
└─ prompt_cache_retention	string or null		No
└─ reasoning	OpenAI.Reasoning or null		No
└─ safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
└─ status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
└─ temperature	number or null		No	1
└─ text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
└─ tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
└─ tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
└─ top_logprobs	integer or null		No
└─ top_p	number or null		No	1
└─ truncation	string or null		No	disabled
└─ usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
└─ user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.failed. Possible values: response.failed	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Emitted when a file search call is initiated.

Name	Type	Description	Required	Default
item_id	string	The ID of the output item that the file search call is initiated.	Yes
output_index	integer	The index of the output item that the file search call is initiated.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.file_search_call.in_progress. Possible values: response.file_search_call.in_progress	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Emitted when a file search is currently searching.

Name	Type	Description	Required	Default
item_id	string	The ID of the output item that the file search call is initiated.	Yes
output_index	integer	The index of the output item that the file search call is searching.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.file_search_call.searching. Possible values: response.file_search_call.searching	Yes

OpenAI.ResponseFormatJsonSchemaSchema

JSON schema

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

Type: object

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Emitted when there is a partial function-call arguments delta.

Name	Type	Description	Required	Default
delta	string	The function-call arguments delta that is added.	Yes
item_id	string	The ID of the output item that the function-call arguments delta is added to.	Yes
output_index	integer	The index of the output item that the function-call arguments delta is added to.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.function_call_arguments.delta. Possible values: response.function_call_arguments.delta	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGeneratingEvent

Emitted when an image generation tool call is actively generating an image (intermediate state).

Name	Type	Description	Required	Default
item_id	string	The unique identifier of the image generation item being processed.	Yes
output_index	integer	The index of the output item in the response's output array.	Yes
sequence_number	integer	The sequence number of the image generation item being processed.	Yes
type	enum	The type of the event. Always 'response.image_generation_call.generating'. Possible values: response.image_generation_call.generating	Yes

OpenAI.ResponseImageGenCallInProgressEvent

ResponseImageGenCallInProgressEvent

Emitted when an image generation tool call is in progress.

Name	Type	Description	Required	Default
item_id	string	The unique identifier of the image generation item being processed.	Yes
output_index	integer	The index of the output item in the response's output array.	Yes
sequence_number	integer	The sequence number of the image generation item being processed.	Yes
type	enum	The type of the event. Always 'response.image_generation_call.in_progress'. Possible values: response.image_generation_call.in_progress	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

ResponseImageGenCallPartialImageEvent

Emitted when a partial image is available during image generation streaming.

Name	Type	Description	Required	Default
item_id	string	The unique identifier of the image generation item being processed.	Yes
output_index	integer	The index of the output item in the response's output array.	Yes
partial_image_b64	string	Base64-encoded partial image data, suitable for rendering as an image.	Yes
partial_image_index	integer	0-based index for the partial image (backend is 1-based, but this is 0-based for the user).	Yes
sequence_number	integer	The sequence number of the image generation item being processed.	Yes
type	enum	The type of the event. Always 'response.image_generation_call.partial_image'. Possible values: response.image_generation_call.partial_image	Yes

OpenAI.ResponseInProgressEvent

Emitted when the response is in progress.

Name	Type	Description	Required	Default
response	OpenAI.Response		Yes
└─ background	boolean or null		No
└─ completed_at	string or null (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
└─ conversation	OpenAI.ConversationReference or null		No
└─ created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
└─ error	OpenAI.ResponseError or null		Yes
└─ id	string	Unique identifier for this Response.	Yes
└─ incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
└─ instructions	string or array of OpenAI.InputItem or null		Yes
└─ max_output_tokens	integer or null		No
└─ max_tool_calls	integer or null		No
└─ metadata	OpenAI.Metadata or null		No
└─ model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
└─ object	enum	The object type of this resource - always set to response. Possible values: response	Yes
└─ output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
└─ output_text	string or null		No
└─ parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
└─ previous_response_id	string or null		No
└─ prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
└─ prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
└─ prompt_cache_retention	string or null		No
└─ reasoning	OpenAI.Reasoning or null		No
└─ safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
└─ status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
└─ temperature	number or null		No	1
└─ text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
└─ tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
└─ tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
└─ top_logprobs	integer or null		No
└─ top_p	number or null		No	1
└─ truncation	string or null		No	disabled
└─ usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
└─ user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.in_progress. Possible values: response.in_progress	Yes

OpenAI.ResponseIncompleteDetails

Name	Type	Description	Required	Default
reason	enum	Possible values: max_output_tokens, content_filter	No

OpenAI.ResponseIncompleteEvent

An event that is emitted when a response finishes as incomplete.

Name	Type	Description	Required	Default
response	OpenAI.Response		Yes
└─ background	boolean or null		No
└─ completed_at	string or null (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
└─ conversation	OpenAI.ConversationReference or null		No
└─ created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
└─ error	OpenAI.ResponseError or null		Yes
└─ id	string	Unique identifier for this Response.	Yes
└─ incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
└─ instructions	string or array of OpenAI.InputItem or null		Yes
└─ max_output_tokens	integer or null		No
└─ max_tool_calls	integer or null		No
└─ metadata	OpenAI.Metadata or null		No
└─ model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
└─ object	enum	The object type of this resource - always set to response. Possible values: response	Yes
└─ output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
└─ output_text	string or null		No
└─ parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
└─ previous_response_id	string or null		No
└─ prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
└─ prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
└─ prompt_cache_retention	string or null		No
└─ reasoning	OpenAI.Reasoning or null		No
└─ safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
└─ status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
└─ temperature	number or null		No	1
└─ text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
└─ tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
└─ tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
└─ top_logprobs	integer or null		No
└─ top_p	number or null		No	1
└─ truncation	string or null		No	disabled
└─ usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
└─ user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.incomplete. Possible values: response.incomplete	Yes

OpenAI.ResponseItemList

A list of Response items.

Name	Type	Description	Required	Default
data	array of OpenAI.ItemResource	A list of items used to generate this response.	Yes
first_id	string	The ID of the first item in the list.	Yes
has_more	boolean	Whether there are more items available.	Yes
last_id	string	The ID of the last item in the list.	Yes
object	enum	The type of object returned, must be list. Possible values: list	Yes

OpenAI.ResponseLogProb

A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) logprob values indicate greater model confidence in that token choice.

Name	Type	Description	Required	Default
logprob	number	The log probability of this token.	Yes
token	string	A possible text token.	Yes
top_logprobs	array of OpenAI.ResponseLogProbTopLogprobs	The log probability of the top 20 most likely tokens.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Type	Description	Required	Default
logprob	number		No
token	string		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

ResponseMCPCallArgumentsDeltaEvent

Emitted when there is a delta (partial update) to the arguments of an MCP tool call.

Name	Type	Description	Required	Default
delta	string	A JSON string containing the partial update to the arguments for the MCP tool call.	Yes
item_id	string	The unique identifier of the MCP tool call item being processed.	Yes
output_index	integer	The index of the output item in the response's output array.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always 'response.mcp_call_arguments.delta'. Possible values: response.mcp_call_arguments.delta	Yes

OpenAI.ResponseMCPCallFailedEvent

ResponseMCPCallFailedEvent

Emitted when an MCP tool call has failed.

Name	Type	Description	Required	Default
item_id	string	The ID of the MCP tool call item that failed.	Yes
output_index	integer	The index of the output item that failed.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always 'response.mcp_call.failed'. Possible values: response.mcp_call.failed	Yes

OpenAI.ResponseMCPCallInProgressEvent

ResponseMCPCallInProgressEvent

Emitted when an MCP tool call is in progress.

Name	Type	Description	Required	Default
item_id	string	The unique identifier of the MCP tool call item being processed.	Yes
output_index	integer	The index of the output item in the response's output array.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always 'response.mcp_call.in_progress'. Possible values: response.mcp_call.in_progress	Yes

OpenAI.ResponseMCPListToolsFailedEvent

ResponseMCPListToolsFailedEvent

Emitted when the attempt to list available MCP tools has failed.

Name	Type	Description	Required	Default
item_id	string	The ID of the MCP tool call item that failed.	Yes
output_index	integer	The index of the output item that failed.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always 'response.mcp_list_tools.failed'. Possible values: response.mcp_list_tools.failed	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

ResponseMCPListToolsInProgressEvent

Emitted when the system is in the process of retrieving the list of available MCP tools.

Name	Type	Description	Required	Default
item_id	string	The ID of the MCP tool call item that is being processed.	Yes
output_index	integer	The index of the output item that is being processed.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always 'response.mcp_list_tools.in_progress'. Possible values: response.mcp_list_tools.in_progress	Yes

OpenAI.ResponseOutputItemAddedEvent

Emitted when a new output item is added.

Name	Type	Description	Required	Default
item	OpenAI.OutputItem		Yes
└─ type	OpenAI.OutputItemType		Yes
output_index	integer	The index of the output item that was added.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.output_item.added. Possible values: response.output_item.added	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

ResponseOutputTextAnnotationAddedEvent

Emitted when an annotation is added to output text content.

Name	Type	Description	Required	Default
annotation	OpenAI.Annotation	An annotation that applies to a span of output text.	Yes
└─ type	OpenAI.AnnotationType		Yes
annotation_index	integer	The index of the annotation within the content part.	Yes
content_index	integer	The index of the content part within the output item.	Yes
item_id	string	The unique identifier of the item to which the annotation is being added.	Yes
output_index	integer	The index of the output item in the response's output array.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always 'response.output_text.annotation.added'. Possible values: response.output_text.annotation.added	Yes

OpenAI.ResponsePromptVariables

Prompt Variables

Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

Type: object

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

Emitted when a response is queued and waiting to be processed.

Name	Type	Description	Required	Default
response	OpenAI.Response		Yes
└─ background	boolean or null		No
└─ completed_at	string or null (unixTimestamp)		No
└─ content_filters	array of AzureContentFilterForResponsesAPI	The content filter results from RAI.	Yes
└─ conversation	OpenAI.ConversationReference or null		No
└─ created_at	integer (unixtime)	Unix timestamp (in seconds) of when this Response was created.	Yes
└─ error	OpenAI.ResponseError or null		Yes
└─ id	string	Unique identifier for this Response.	Yes
└─ incomplete_details	OpenAI.ResponseIncompleteDetails or null		Yes
└─ instructions	string or array of OpenAI.InputItem or null		Yes
└─ max_output_tokens	integer or null		No
└─ max_tool_calls	integer or null		No
└─ metadata	OpenAI.Metadata or null		No
└─ model	string	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.	No
└─ object	enum	The object type of this resource - always set to response. Possible values: response	Yes
└─ output	array of OpenAI.OutputItem	An array of content items generated by the model. - The length and order of items in the output array is dependent on the model's response. - Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.	Yes
└─ output_text	string or null		No
└─ parallel_tool_calls	boolean	Whether to allow the model to run tool calls in parallel.	Yes	True
└─ previous_response_id	string or null		No
└─ prompt	OpenAI.Prompt	Reference to a prompt template and its variables. Learn more.	No
└─ prompt_cache_key	string	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.	No
└─ prompt_cache_retention	string or null		No
└─ reasoning	OpenAI.Reasoning or null		No
└─ safety_identifier	string	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. Learn more.	No
└─ status	enum	The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Possible values: completed, failed, in_progress, cancelled, queued, incomplete	No
└─ temperature	number or null		No	1
└─ text	OpenAI.ResponseTextParam	Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - Text inputs and outputs - Structured Outputs	No
└─ tool_choice	OpenAI.ToolChoiceParam	How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.	No
└─ tools	OpenAI.ToolsArray	An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools: - Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools. - MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools. - Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.	No
└─ top_logprobs	integer or null		No
└─ top_p	number or null		No	1
└─ truncation	string or null		No	disabled
└─ usage	OpenAI.ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.	No
└─ user	string (deprecated)	This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.	No
sequence_number	integer	The sequence number for this event.	Yes
type	enum	The type of the event. Always 'response.queued'. Possible values: response.queued	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitted when a new reasoning summary part is added.

Name	Type	Description	Required	Default
item_id	string	The ID of the item this summary part is associated with.	Yes
output_index	integer	The index of the output item this summary part is associated with.	Yes
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└─ text	string		Yes
└─ type	enum	Possible values: summary_text	Yes
sequence_number	integer	The sequence number of this event.	Yes
summary_index	integer	The index of the summary part within the reasoning summary.	Yes
type	enum	The type of the event. Always response.reasoning_summary_part.added. Possible values: response.reasoning_summary_part.added	Yes

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Type	Description	Required	Default
text	string		Yes
type	enum	Possible values: summary_text	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitted when a delta is added to a reasoning summary text.

Name	Type	Description	Required	Default
delta	string	The text delta that was added to the summary.	Yes
item_id	string	The ID of the item this summary text delta is associated with.	Yes
output_index	integer	The index of the output item this summary text delta is associated with.	Yes
sequence_number	integer	The sequence number of this event.	Yes
summary_index	integer	The index of the summary part within the reasoning summary.	Yes
type	enum	The type of the event. Always response.reasoning_summary_text.delta. Possible values: response.reasoning_summary_text.delta	Yes

OpenAI.ResponseReasoningTextDeltaEvent

Emitted when a delta is added to a reasoning text.

Name	Type	Description	Required	Default
content_index	integer	The index of the reasoning content part this delta is associated with.	Yes
delta	string	The text delta that was added to the reasoning content.	Yes
item_id	string	The ID of the item this reasoning text delta is associated with.	Yes
output_index	integer	The index of the output item this reasoning text delta is associated with.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.reasoning_text.delta. Possible values: response.reasoning_text.delta	Yes

OpenAI.ResponseRefusalDeltaEvent

Emitted when there is a partial refusal text.

Name	Type	Description	Required	Default
content_index	integer	The index of the content part that the refusal text is added to.	Yes
delta	string	The refusal text that is added.	Yes
item_id	string	The ID of the output item that the refusal text is added to.	Yes
output_index	integer	The index of the output item that the refusal text is added to.	Yes
sequence_number	integer	The sequence number of this event.	Yes
type	enum	The type of the event. Always response.refusal.delta. Possible values: response.refusal.delta	Yes

OpenAI.ResponseStreamOptions

Options for streaming responses. Only set this when you set stream: true.

Name	Type	Description	Required	Default
include_obfuscation	boolean	When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.	No

OpenAI.ResponseTextDeltaEvent

Emitted when there is an additional text delta.

Name	Type	Description	Required	Default
content_index	integer	The index of the content part that the text delta was added to.	Yes
delta	string	The text delta that was added.	Yes
item_id	string	The ID of the output item that the text delta was added to.	Yes
logprobs	array of OpenAI.ResponseLogProb	The log probabilities of the tokens in the delta.	Yes
output_index	integer	The index of the output item that the text delta was added to.	Yes
sequence_number	integer	The sequence number for this event.	Yes
type	enum	The type of the event. Always response.output_text.delta. Possible values: response.output_text.delta	Yes

OpenAI.ResponseTextParam

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

• Text inputs and outputs
• Structured Outputs

Name	Type	Description	Required	Default
format	OpenAI.TextResponseFormatConfiguration	An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the The default format is { "type": "text" } with no additional options. Not recommended for gpt-4o and newer models: Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.	No
verbosity	OpenAI.Verbosity	Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are low, medium, and high.	No

OpenAI.ResponseUsage

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Name	Type	Description	Required	Default
input_tokens	integer	The number of input tokens.	Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└─ cached_tokens	integer		Yes
output_tokens	integer	The number of output tokens.	Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ reasoning_tokens	integer		Yes
total_tokens	integer	The total number of tokens used.	Yes

OpenAI.ResponseUsageInputTokensDetails

Name	Type	Description	Required	Default
cached_tokens	integer		Yes

OpenAI.ResponseUsageOutputTokensDetails

Name	Type	Description	Required	Default
reasoning_tokens	integer		Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Note: web_search is not yet available via Azure OpenAI.

Name	Type	Description	Required	Default
item_id	string	Unique ID for the output item associated with the web search call.	Yes
output_index	integer	The index of the output item that the web search call is associated with.	Yes
sequence_number	integer	The sequence number of the web search call being processed.	Yes
type	enum	The type of the event. Always response.web_search_call.in_progress. Possible values: response.web_search_call.in_progress	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Note: web_search is not yet available via Azure OpenAI.

Name	Type	Description	Required	Default
item_id	string	Unique ID for the output item associated with the web search call.	Yes
output_index	integer	The index of the output item that the web search call is associated with.	Yes
sequence_number	integer	The sequence number of the web search call being processed.	Yes
type	enum	The type of the event. Always response.web_search_call.searching. Possible values: response.web_search_call.searching	Yes

OpenAI.Screenshot

Screenshot

A screenshot action.

Name	Type	Description	Required	Default
type	enum	Specifies the event type. For a screenshot action, this property is always set to screenshot. Possible values: screenshot	Yes	screenshot

OpenAI.Scroll

Scroll

A scroll action.

Name	Type	Description	Required	Default
scroll_x	integer	The horizontal scroll distance.	Yes
scroll_y	integer	The vertical scroll distance.	Yes
type	enum	Specifies the event type. For a scroll action, this property is always set to scroll. Possible values: scroll	Yes	scroll
x	integer	The x-coordinate where the scroll occurred.	Yes
y	integer	The y-coordinate where the scroll occurred.	Yes

OpenAI.SearchContextSize

Property	Value
Type	string
Values	low medium high

OpenAI.SpecificApplyPatchParam

Specific apply patch tool choice

Forces the model to call the apply_patch tool when executing a tool call.

Name	Type	Description	Required	Default
type	enum	The tool to call. Always apply_patch. Possible values: apply_patch	Yes	apply_patch

OpenAI.SpecificFunctionShellParam

Specific shell tool choice

Forces the model to call the shell tool when a tool call is required.

Name	Type	Description	Required	Default
type	enum	The tool to call. Always shell. Possible values: shell	Yes	shell

OpenAI.Summary

Summary text

A summary text from the model.

Name	Type	Description	Required	Default
text	string	A summary of the reasoning output from the model so far.	Yes
type	enum	The type of the object. Always summary_text. Possible values: summary_text	Yes	summary_text

OpenAI.TextResponseFormatConfiguration

An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the

The default format is { "type": "text" } with no additional options. Not recommended for gpt-4o and newer models: Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.

Discriminator for OpenAI.TextResponseFormatConfiguration

This component uses the property type to discriminate between different types:

Type Value	Schema
json_schema	OpenAI.TextResponseFormatJsonSchema
text	OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Type	Description	Required	Default
type	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON object

JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.

Name	Type	Description	Required	Default
type	enum	The type of response format being defined. Always json_object. Possible values: json_object	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

Default response format. Used to generate text responses.

Name	Type	Description	Required	Default
type	enum	The type of response format being defined. Always text. Possible values: text	Yes

OpenAI.TextResponseFormatConfigurationType

Property	Value
Type	string
Values	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

JSON schema

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

Name	Type	Description	Required	Default
description	string	A description of what the response format is for, used by the model to determine how to respond in the format.	No
name	string	The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.	Yes
schema	OpenAI.ResponseFormatJsonSchemaSchema	The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.	Yes
strict	boolean or null		No
type	enum	The type of response format being defined. Always json_schema. Possible values: json_schema	Yes

OpenAI.Tool

A tool that can be used to generate a response.

Discriminator for OpenAI.Tool

This component uses the property type to discriminate between different types:

Type Value	Schema
code_interpreter	OpenAI.CodeInterpreterTool
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search	OpenAI.WebSearchTool
mcp	OpenAI.MCPTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellToolParam
shell	OpenAI.FunctionShellToolParam
custom	OpenAI.CustomToolParam
web_search_preview	OpenAI.WebSearchPreviewTool
apply_patch	OpenAI.ApplyPatchToolParam

Name	Type	Description	Required	Default
type	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Allowed tools

Constrains the tools available to the model to a pre-defined set.

Name	Type	Description	Required	Default
mode	enum	Constrains the tools available to the model to a pre-defined set. auto allows the model to pick from among the allowed tools and generate a message. required requires the model to call one or more of the allowed tools. Possible values: auto, required	Yes
tools	array of object	A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>	Yes
type	enum	Allowed tool configuration type. Always allowed_tools. Possible values: allowed_tools	Yes

OpenAI.ToolChoiceCodeInterpreter

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Name	Type	Description	Required	Default
type	enum	Possible values: code_interpreter	Yes

OpenAI.ToolChoiceComputerUsePreview

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Name	Type	Description	Required	Default
type	enum	Possible values: computer_use_preview	Yes

OpenAI.ToolChoiceCustom

Custom tool

Use this option to force the model to call a specific custom tool.

Name	Type	Description	Required	Default
name	string	The name of the custom tool to call.	Yes
type	enum	For custom tool calling, the type is always custom. Possible values: custom	Yes

OpenAI.ToolChoiceFileSearch

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Name	Type	Description	Required	Default
type	enum	Possible values: file_search	Yes

OpenAI.ToolChoiceImageGeneration

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Name	Type	Description	Required	Default
type	enum	Possible values: image_generation	Yes

OpenAI.ToolChoiceMCP

MCP tool

Use this option to force the model to call a specific tool on a remote MCP server.

Name	Type	Description	Required	Default
name	string or null		No
server_label	string	The label of the MCP server to use.	Yes
type	enum	For MCP tools, the type is always mcp. Possible values: mcp	Yes

OpenAI.ToolChoiceParam

How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.

Discriminator for OpenAI.ToolChoiceParam

This component uses the property type to discriminate between different types:

Type Value	Schema
allowed_tools	OpenAI.ToolChoiceAllowed
mcp	OpenAI.ToolChoiceMCP
custom	OpenAI.ToolChoiceCustom
apply_patch	OpenAI.SpecificApplyPatchParam
shell	OpenAI.SpecificFunctionShellParam
file_search	OpenAI.ToolChoiceFileSearch
web_search_preview	OpenAI.ToolChoiceWebSearchPreview
computer_use_preview	OpenAI.ToolChoiceComputerUsePreview
web_search_preview_2025_03_11	OpenAI.ToolChoiceWebSearchPreview20250311
image_generation	OpenAI.ToolChoiceImageGeneration
code_interpreter	OpenAI.ToolChoiceCodeInterpreter

Name	Type	Description	Required	Default
type	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Property	Value
Type	string
Values	allowed_tools function mcp custom apply_patch shell file_search web_search_preview computer_use_preview web_search_preview_2025_03_11 image_generation code_interpreter

OpenAI.ToolChoiceWebSearchPreview

Note: web_search is not yet available via Azure OpenAI.

Name	Type	Description	Required	Default
type	enum	Possible values: web_search_preview	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Name	Type	Description	Required	Default
type	enum	Possible values: web_search_preview_2025_03_11	Yes

OpenAI.ToolType

Property	Value
Type	string
Values	function file_search computer_use_preview web_search mcp code_interpreter image_generation local_shell shell custom web_search_preview apply_patch

OpenAI.ToolsArray

An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter. We support the following categories of tools:

• Built-in tools: Tools that are provided by OpenAI that extend the model's capabilities, like web search or file search. Learn more about built-in tools.
• MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about MCP Tools.
• Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. Learn more about function calling. You can also use custom tools to call your own code.

Array of: OpenAI.Tool

OpenAI.TopLogProb

Top log probability

The top log probability of a token.

Name	Type	Description	Required	Default
bytes	array of integer		Yes
logprob	number		Yes
token	string		Yes

OpenAI.Type

Type

An action to type in text.

Name	Type	Description	Required	Default
text	string	The text to type.	Yes
type	enum	Specifies the event type. For a type action, this property is always set to type. Possible values: type	Yes	type

OpenAI.UrlCitationBody

URL citation

A citation for a web resource used to generate a model response.

Name	Type	Description	Required	Default
end_index	integer	The index of the last character of the URL citation in the message.	Yes
start_index	integer	The index of the first character of the URL citation in the message.	Yes
title	string	The title of the web resource.	Yes
type	enum	The type of the URL citation. Always url_citation. Possible values: url_citation	Yes	url_citation
url	string (uri)	The URL of the web resource.	Yes

OpenAI.VectorStoreFileAttributes

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Type: object

OpenAI.Verbosity

Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are low, medium, and high.

Property	Value
Description	Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are low, medium, and high.
Type	string
Values	low medium high

OpenAI.Wait

Wait

A wait action.

Name	Type	Description	Required	Default
type	enum	Specifies the event type. For a wait action, this property is always set to wait. Possible values: wait	Yes	wait

OpenAI.WebSearchActionFind

Find action

Action type "find": Searches for a pattern within a loaded page.

Name	Type	Description	Required	Default
pattern	string	The pattern or text to search for within the page.	Yes
type	enum	The action type. Possible values: find_in_page	Yes
url	string (uri)	The URL of the page searched for the pattern.	Yes

OpenAI.WebSearchActionOpenPage

Open page action

Action type "open_page" - Opens a specific URL from search results.

Name	Type	Description	Required	Default
type	enum	The action type. Possible values: open_page	Yes
url	string (uri)	The URL opened by the model.	Yes

OpenAI.WebSearchActionSearch

Search action

Action type "search" - Performs a web search query.

Name	Type	Description	Required	Default
queries	array of string	The search queries.	No
query	string (deprecated)	[DEPRECATED] The search query.	Yes
sources	array of OpenAI.WebSearchActionSearchSources	The sources used in the search.	No
type	enum	The action type. Possible values: search	Yes

OpenAI.WebSearchActionSearchSources

Name	Type	Description	Required	Default
type	enum	Possible values: url	Yes
url	string		Yes

OpenAI.WebSearchApproximateLocation

Web search approximate location

The approximate location of the user.

Name	Type	Description	Required	Default
city	string or null		No
country	string or null		No
region	string or null		No
timezone	string or null		No
type	enum	The type of location approximation. Always approximate. Possible values: approximate	No	approximate

OpenAI.WebSearchPreviewTool

Web search preview

Note: web_search is not yet available via Azure OpenAI.

Name	Type	Description	Required	Default
search_context_size	OpenAI.SearchContextSize		No
type	enum	The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11. Possible values: web_search_preview	Yes	web_search_preview
user_location	OpenAI.ApproximateLocation or null		No

OpenAI.WebSearchTool

Web search

Note: web_search is not yet available via Azure OpenAI.

Name	Type	Description	Required	Default
filters	OpenAI.WebSearchToolFilters or null		No
search_context_size	enum	High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default. Possible values: low, medium, high	No	medium
type	enum	The type of the web search tool. One of web_search or web_search_2025_08_26. Possible values: web_search	Yes	web_search
user_location	OpenAI.WebSearchApproximateLocation or null		No

OpenAI.WebSearchToolFilters

Name	Type	Description	Required	Default
allowed_domains	array of string or null		No