Expand description
Native OpenAI Responses input, output items, tool and configuration shapes.
The request uses the same native input and tool shapes as Responses. The types here deliberately remain OpenAI-shaped; they are not a shared IR.
Shapes follow Get input token counts.md, including native history items.
Known structures are typed; rest retains only unknown extension fields.
Structs§
- Additional
Tools - Additional
Tools Builder - Builder for
AdditionalTools. - Apply
Patch Call - Apply
Patch Call Builder - Builder for
ApplyPatchCall. - Apply
Patch Call Output - Apply
Patch Call Output Builder - Builder for
ApplyPatchCallOutput. - Apply
Patch Create - Apply
Patch Create Builder - Builder for
ApplyPatchCreate. - Apply
Patch Delete - Apply
Patch Delete Builder - Builder for
ApplyPatchDelete. - Apply
Patch Update - Apply
Patch Update Builder - Builder for
ApplyPatchUpdate. - Click
Action - Click
Action Builder - Builder for
ClickAction. - Code
Image - Code
Image Builder - Builder for
CodeImage. - Code
Interpreter Call - Code
Interpreter Call Builder - Builder for
CodeInterpreterCall. - Code
Logs - Code
Logs Builder - Builder for
CodeLogs. - Compaction
- Compaction
Builder - Builder for
Compaction. - Compaction
Trigger - Compaction
Trigger Builder - Builder for
CompactionTrigger. - Computer
Call - Computer
Call Builder - Builder for
ComputerCall. - Computer
Call Output - Computer
Call Output Builder - Builder for
ComputerCallOutput. - Computer
Screenshot - Computer
Screenshot Builder - Builder for
ComputerScreenshot. - Configuration
Reasoning - Configuration
Reasoning Builder - Builder for
ConfigurationReasoning. - Configuration
Update - Configuration
Update Builder - Builder for
ConfigurationUpdate. - Container
File Citation - Container
File Citation Builder - Builder for
ContainerFileCitation. - Coordinate
- Coordinate
Builder - Builder for
Coordinate. - Custom
Tool Call - Custom
Tool Call Builder - Builder for
CustomToolCall. - Custom
Tool Call Output - Custom
Tool Call Output Builder - Builder for
CustomToolCallOutput. - Direct
Caller - Direct
Caller Builder - Builder for
DirectCaller. - Double
Click Action - Double
Click Action Builder - Builder for
DoubleClickAction. - Drag
Action - Drag
Action Builder - Builder for
DragAction. - Easy
Input Message - Easy
Input Message Builder - Builder for
EasyInputMessage. - File
Citation - File
Citation Builder - Builder for
FileCitation. - File
Path - File
Path Builder - Builder for
FilePath. - File
Search Call - File
Search Call Builder - Builder for
FileSearchCall. - File
Search Result - File
Search Result Builder - Builder for
FileSearchResult. - Function
Call - Function
Call Builder - Builder for
FunctionCall. - Function
Call Output - Function
Call Output Builder - Builder for
FunctionCallOutput. - Function
Output File - Function
Output File Builder - Builder for
FunctionOutputFile. - Function
Output Image - Function
Output Image Builder - Builder for
FunctionOutputImage. - Function
Output Text - Function
Output Text Builder - Builder for
FunctionOutputText. - Image
Generation Call - Image
Generation Call Builder - Builder for
ImageGenerationCall. - Input
Message - Input
Message Builder - Builder for
InputMessage. - Item
Reference - Item
Reference Builder - Builder for
ItemReference. - Keypress
Action - Keypress
Action Builder - Builder for
KeypressAction. - Local
Shell Action - Local
Shell Action Builder - Builder for
LocalShellAction. - Local
Shell Call - Local
Shell Call Builder - Builder for
LocalShellCall. - Local
Shell Call Output - Local
Shell Call Output Builder - Builder for
LocalShellCallOutput. - McpApproval
Request - McpApproval
Request Builder - Builder for
McpApprovalRequest. - McpApproval
Response - McpApproval
Response Builder - Builder for
McpApprovalResponse. - McpCall
- McpCall
Builder - Builder for
McpCall. - McpList
Tools - McpList
Tools Builder - Builder for
McpListTools. - McpTool
Definition - McpTool
Definition Builder - Builder for
McpToolDefinition. - Move
Action - Move
Action Builder - Builder for
MoveAction. - Output
Logprob - Output
Logprob Builder - Builder for
OutputLogprob. - Pending
Safety Check - Pending
Safety Check Builder - Builder for
PendingSafetyCheck. - Program
- Program
Builder - Builder for
Program. - Program
Caller - Program
Caller Builder - Builder for
ProgramCaller. - Program
Output - Program
Output Builder - Builder for
ProgramOutput. - Prompt
Cache Breakpoint - Prompt
Cache Breakpoint Builder - Builder for
PromptCacheBreakpoint. - Reasoning
Config - Reasoning
Config Builder - Builder for
ReasoningConfig. - Reasoning
Content - Reasoning
Content Builder - Builder for
ReasoningContent. - Reasoning
Item - Reasoning
Item Builder - Builder for
ReasoningItem. - Response
Conversation Param - Response
Conversation Param Builder - Builder for
ResponseConversationParam. - Response
Input File - Response
Input File Builder - Builder for
ResponseInputFile. - Response
Input Image - Response
Input Image Builder - Builder for
ResponseInputImage. - Response
Input Text - Response
Input Text Builder - Builder for
ResponseInputText. - Response
Output Message - Response
Output Message Builder - Builder for
ResponseOutputMessage. - Response
Output Refusal - Response
Output Refusal Builder - Builder for
ResponseOutputRefusal. - Response
Output Text - Response
Output Text Builder - Builder for
ResponseOutputText. - Screenshot
Action - Screenshot
Action Builder - Builder for
ScreenshotAction. - Scroll
Action - Scroll
Action Builder - Builder for
ScrollAction. - Shell
Action - Shell
Action Builder - Builder for
ShellAction. - Shell
Call - Shell
Call Builder - Builder for
ShellCall. - Shell
Call Output - Shell
Call Output Builder - Builder for
ShellCallOutput. - Shell
Exit - Shell
Exit Builder - Builder for
ShellExit. - Shell
Output Content - Shell
Output Content Builder - Builder for
ShellOutputContent. - Shell
Timeout - Shell
Timeout Builder - Builder for
ShellTimeout. - Summary
Text - Summary
Text Builder - Builder for
SummaryText. - Text
Config - Text
Config Builder - Builder for
TextConfig. - Text
Format Json Object - Text
Format Json Object Builder - Builder for
TextFormatJsonObject. - Text
Format Json Schema - Text
Format Json Schema Builder - Builder for
TextFormatJsonSchema. - Text
Format Text - Text
Format Text Builder - Builder for
TextFormatText. - Tool
Choice Allowed - Tool
Choice Allowed Builder - Builder for
ToolChoiceAllowed. - Tool
Choice Apply Patch - Tool
Choice Apply Patch Builder - Builder for
ToolChoiceApplyPatch. - Tool
Choice Custom - Tool
Choice Custom Builder - Builder for
ToolChoiceCustom. - Tool
Choice Function - Tool
Choice Function Builder - Builder for
ToolChoiceFunction. - Tool
Choice Hosted - Tool
Choice Hosted Builder - Builder for
ToolChoiceHosted. - Tool
Choice Mcp - Tool
Choice McpBuilder - Builder for
ToolChoiceMcp. - Tool
Choice Programmatic - Tool
Choice Programmatic Builder - Builder for
ToolChoiceProgrammatic. - Tool
Choice Shell - Tool
Choice Shell Builder - Builder for
ToolChoiceShell. - Tool
Search Call - Tool
Search Call Builder - Builder for
ToolSearchCall. - Tool
Search Output - Tool
Search Output Builder - Builder for
ToolSearchOutput. - TopLogprob
- TopLogprob
Builder - Builder for
TopLogprob. - Type
Action - Type
Action Builder - Builder for
TypeAction. - UrlCitation
- UrlCitation
Builder - Builder for
UrlCitation. - Wait
Action - Wait
Action Builder - Builder for
WaitAction. - WebSearch
Call - WebSearch
Call Builder - Builder for
WebSearchCall. - WebSearch
Find InPage - WebSearch
Find InPage Builder - Builder for
WebSearchFindInPage. - WebSearch
Open Page - WebSearch
Open Page Builder - Builder for
WebSearchOpenPage. - WebSearch
Query - WebSearch
Query Builder - Builder for
WebSearchQuery. - WebSearch
Source - WebSearch
Source Builder - Builder for
WebSearchSource.
Enums§
- Additional
Tools Role - Additional
Tools Type - Allowed
Tool Choice Mode - Apply
Patch Call Output Type - Apply
Patch Call Type - Apply
Patch Operation - Apply
Patch Output Status - Apply
Patch Status - Caller
- Click
Button - Code
Interpreter Call Type - Code
Interpreter Output - Code
Interpreter Status - Compaction
Trigger Type - Compaction
Type - Computer
Action - Computer
Call Output Type - Computer
Call Type - Computer
Screenshot Type - Configuration
Update Type - Container
File Citation Type - Conversation
Param - Custom
Output - Custom
Tool Call Output Type - Custom
Tool Call Type - File
Attribute Value - File
Citation Type - File
Detail - File
Path Type - File
Search Call Type - File
Search Status - Function
Call Output Type - Function
Call Type - Function
Output - Function
Output Content - Image
Detail - Image
Generation Call Type - Image
Generation Status - Input
- Input
Content - Input
Item - Input
Message Role - Item
Reference Type - Item
Status - Local
Shell Action Type - Local
Shell Call Output Type - Local
Shell Call Type - McpApproval
Request Type - McpApproval
Response Type - McpCall
Status - McpCall
Type - McpList
Tools Type - Message
Content - Message
Phase - Message
Role - Message
Type - Output
Annotation - Output
Content - Output
Message Role - Output
Message Status - Program
Output Status - Program
Output Type - Program
Type - Prompt
Cache Breakpoint Ttl - Explicit cache-breakpoint lifetimes from OpenAI’s PromptCacheBreakpointParam. Separate from the request-wide PromptCacheTTLEnum and legacy retention policy.
- Prompt
Cache Mode - Reasoning
Context - Reasoning
Effort - Reasoning
Item Type - Reasoning
Status - Reasoning
Summary - Reasoning
Text Type - Response
Input File Type - Response
Input Image Type - Response
Input Text Type - Response
Output Refusal Type - Response
Output Text Type - Shell
Call Environment - Shell
Call Output Type - Shell
Call Type - Shell
Output Outcome - Summary
Text Type - Text
Format - Text
Verbosity - Tool
Choice - Tool
Choice Allowed Type - Tool
Choice Apply Patch Type - Tool
Choice Custom Type - Tool
Choice Function Type - Tool
Choice Hosted Type - Tool
Choice McpType - Tool
Choice Mode - Tool
Choice Programmatic Type - Tool
Choice Shell Type - Tool
Search Call Type - Tool
Search Output Type - UrlCitation
Type - WebSearch
Action - WebSearch
Call Type - WebSearch
Source Type - WebSearch
Status