Authorizations
Headers
Body
application/json
model specified as model_vendor/model
, for example openai/gpt-4o
Which fields to include in the response
Instructions for the response generation
Maximum number of output tokens
Metadata for the response
Whether to enable parallel tool calls
ID of the previous response for chaining
Reasoning configuration for the response
Whether to store the response
Whether to stream the response
Sampling temperature for randomness control
Required range:
0 <= x <= 2
Text configuration parameters
Tool choice configuration
Tools available for the response
Top-p sampling parameter
Required range:
0 <= x <= 1
Truncation configuration
Available options:
auto
, disabled
Response
Successful Response
- Response Post-V5-/V5/Responses
- ResponseAudioDeltaEvent
- ResponseAudioDoneEvent
- ResponseAudioTranscriptDeltaEvent
- ResponseAudioTranscriptDoneEvent
- ResponseCodeInterpreterCallCodeDeltaEvent
- ResponseCodeInterpreterCallCodeDoneEvent
- ResponseCodeInterpreterCallCompletedEvent
- ResponseCodeInterpreterCallInProgressEvent
- ResponseCodeInterpreterCallInterpretingEvent
- ResponseCompletedEvent
- ResponseContentPartAddedEvent
- ResponseContentPartDoneEvent
- ResponseCreatedEvent
- ResponseErrorEvent
- ResponseFileSearchCallCompletedEvent
- ResponseFileSearchCallInProgressEvent
- ResponseFileSearchCallSearchingEvent
- ResponseFunctionCallArgumentsDeltaEvent
- ResponseFunctionCallArgumentsDoneEvent
- ResponseInProgressEvent
- ResponseFailedEvent
- ResponseIncompleteEvent
- ResponseOutputItemAddedEvent
- ResponseOutputItemDoneEvent
- ResponseReasoningSummaryPartAddedEvent
- ResponseReasoningSummaryPartDoneEvent
- ResponseReasoningSummaryTextDeltaEvent
- ResponseReasoningSummaryTextDoneEvent
- ResponseReasoningTextDeltaEvent
- ResponseReasoningTextDoneEvent
- ResponseRefusalDeltaEvent
- ResponseRefusalDoneEvent
- ResponseTextDeltaEvent
- ResponseTextDoneEvent
- ResponseWebSearchCallCompletedEvent
- ResponseWebSearchCallInProgressEvent
- ResponseWebSearchCallSearchingEvent
- ResponseImageGenCallCompletedEvent
- ResponseImageGenCallGeneratingEvent
- ResponseImageGenCallInProgressEvent
- ResponseImageGenCallPartialImageEvent
- ResponseMcpCallArgumentsDeltaEvent
- ResponseMcpCallArgumentsDoneEvent
- ResponseMcpCallCompletedEvent
- ResponseMcpCallFailedEvent
- ResponseMcpCallInProgressEvent
- ResponseMcpListToolsCompletedEvent
- ResponseMcpListToolsFailedEvent
- ResponseMcpListToolsInProgressEvent
- ResponseOutputTextAnnotationAddedEvent
- ResponseQueuedEvent
- ResponseCustomToolCallInputDeltaEvent
- ResponseCustomToolCallInputDoneEvent
- GenericResponseEvent
- ResponseOutputMessage
- ResponseFileSearchToolCall
- ResponseFunctionToolCall
- ResponseFunctionWebSearch
- ResponseComputerToolCall
- ResponseReasoningItem
- ImageGenerationCall
- ResponseCodeInterpreterToolCall
- LocalShellCall
- McpCall
- McpListTools
- McpApprovalRequest
- ResponseCustomToolCall
Available options:
none
, auto
, required
- FunctionTool
- FileSearchTool
- WebSearchTool
- ComputerTool
- Mcp
- CodeInterpreter
- ImageGeneration
- LocalShell
- CustomTool
Allowed value:
"response"
Available options:
auto
, default
, flex
, scale
, priority
Available options:
completed
, failed
, in_progress
, cancelled
, queued
, incomplete
Available options:
auto
, disabled