Responses
ResponsesResource
Methods
post/v5/responses
Responses
Parameters
InputUnionMember0 = str
model: str
model specified as model_vendor/model, for example openai/gpt-4o
Which fields to include in the response
instructions: Optional[str]
Instructions for the response generation
max_output_tokens: Optional[int]
Maximum number of output tokens
Metadata for the response
Whether to enable parallel tool calls
previous_response_id: Optional[str]
ID of the previous response for chaining
Reasoning configuration for the response
Whether to store the response
Whether to stream the response
temperature: Optional[float]
(maximum: 2, minimum: 0)Sampling temperature for randomness control
Text configuration parameters
Tool choice configuration
ToolChoiceUnionMember0 = str
top_p: Optional[float]
(maximum: 1, minimum: 0)Top-p sampling parameter
truncation: Optional[Literal["auto", "disabled"]]
Truncation configuration
"auto"
"disabled"
Returns
ResponseCreateResponse =
class ResponseAudioDeltaEvent: ...
class ResponseAudioDoneEvent: ...
class ResponseAudioTranscriptDeltaEvent: ...
class ResponseAudioTranscriptDoneEvent: ...
class ResponseCodeInterpreterCallCodeDeltaEvent: ...
class ResponseCodeInterpreterCallCodeDoneEvent: ...
class ResponseCodeInterpreterCallCompletedEvent: ...
class ResponseCodeInterpreterCallInProgressEvent: ...
class ResponseCodeInterpreterCallInterpretingEvent: ...
class ResponseCompletedEvent: ...
class ResponseContentPartAddedEvent: ...
class ResponseContentPartDoneEvent: ...
class ResponseCreatedEvent: ...
class ResponseErrorEvent: ...
class ResponseFileSearchCallCompletedEvent: ...
class ResponseFileSearchCallInProgressEvent: ...
class ResponseFileSearchCallSearchingEvent: ...
class ResponseFunctionCallArgumentsDeltaEvent: ...
class ResponseFunctionCallArgumentsDoneEvent: ...
class ResponseInProgressEvent: ...
class ResponseFailedEvent: ...
class ResponseIncompleteEvent: ...
class ResponseOutputItemAddedEvent: ...
class ResponseOutputItemDoneEvent: ...
class ResponseReasoningSummaryPartAddedEvent: ...
class ResponseReasoningSummaryPartDoneEvent: ...
class ResponseReasoningSummaryTextDeltaEvent: ...
class ResponseReasoningSummaryTextDoneEvent: ...
class ResponseReasoningTextDeltaEvent: ...
class ResponseReasoningTextDoneEvent: ...
class ResponseRefusalDeltaEvent: ...
class ResponseRefusalDoneEvent: ...
class ResponseTextDeltaEvent: ...
class ResponseTextDoneEvent: ...
class ResponseWebSearchCallCompletedEvent: ...
class ResponseWebSearchCallInProgressEvent: ...
class ResponseWebSearchCallSearchingEvent: ...
class ResponseImageGenCallCompletedEvent: ...
class ResponseImageGenCallGeneratingEvent: ...
class ResponseImageGenCallInProgressEvent: ...
class ResponseImageGenCallPartialImageEvent: ...
class ResponseMcpCallArgumentsDeltaEvent: ...
class ResponseMcpCallArgumentsDoneEvent: ...
class ResponseMcpCallCompletedEvent: ...
class ResponseMcpCallFailedEvent: ...
class ResponseMcpCallInProgressEvent: ...
class ResponseMcpListToolsCompletedEvent: ...
class ResponseMcpListToolsFailedEvent: ...
class ResponseMcpListToolsInProgressEvent: ...
class ResponseOutputTextAnnotationAddedEvent: ...
class ResponseQueuedEvent: ...
class ResponseCustomToolCallInputDeltaEvent: ...
class ResponseCustomToolCallInputDoneEvent: ...
class GenericResponseEvent: ...
Request example
200Example
Domain types
class Response: ...