Structs§
- Code
Interpreter Tool - File
Search Result - A result from file search.
- Function
Tool - Input
Tokens Details - McpTool
- McpTool
Info - MCP Tool information for the mcp_list_tools output item
- Output
Tokens Details - Reasoning
Info - Response
Reasoning Param - Response
Usage - OpenAI Responses API usage format (different from standard UsageInfo)
- Responses
Request - Responses
Response - Text
Config - Text configuration for structured output requests
- WebSearch
Preview Tool - WebSearch
Source - A source returned from web search.
Enums§
- Code
Interpreter Call Status - Status for code interpreter tool calls.
- Code
Interpreter Output - Output from code interpreter execution.
- File
Search Call Status - Status for file search tool calls.
- Include
Field - Reasoning
Effort - Reasoning
Summary - Require
Approval require_approvalvalues.- Response
Content Part - Response
Input - Response
Input Output Item - Response
Output Item - Response
Reasoning Content - Response
Status - Response
Tool - Responses
Usage - Service
Tier - String
OrContent Parts - Content can be either a simple string or array of content parts (for SimpleInputMessage)
- Text
Format - Text format: text (default), json_object (legacy), or json_schema (recommended)
- Truncation
- WebSearch
Action - Action performed during a web search.
- WebSearch
Call Status - Status for web search tool calls.
Functions§
- generate_
id - normalize_
input_ item - Normalize a SimpleInputMessage to a proper Message item
- validate_
conversation_ id - Validate conversation ID format