Expand description
Request body and POST method for the Responses API (POST /responses).
The request format follows the OpenAI Responses API as implemented by the
official Python SDK, restricted to the parameters documented by OpenAI and
the compatible providers (DeepSeek, Qwen). Provider-proprietary parameters
are opt-in via the deepseek / qwen cargo features.
Structs§
- Reasoning
Config - Configuration options for reasoning models.
- Reasoning
Text Part - A plaintext reasoning content part.
- Request
Body - Creates a model response for the given input.
- Summary
Text Part - A reasoning summary content part.
- Text
Config - Configuration options for a text response from the model.
Enums§
- Function
Call Output Content - The output content of a function (or custom tool) call: either plain text or an array of content parts.
- Image
Detail - Controls how an input image is processed.
lowdownscales the image before inference (faster, fewer tokens); the other values keep the original image. - Image
Url - The source of an input image. DeepSeek and Qwen take a plain URL
string; OpenAI takes an object with a
urlfield. - Input
- The
inputparameter: either a plain string (treated as a singleusermessage) or a list of input items. - Input
Content Part - A content part of an input message or tool output.
- Input
Item - An item of the input list.
- Message
Content - The content of an input message: either plain text or an array of content parts.
- Role
- The role of a message author.
- Summary
Effort - The verbosity of reasoning summaries.
- Text
Format - The format of the text output.
- Tool
- A tool the model may call while generating a response.
- Tool
Choice - How the model should select which tool (or tools) to use.
- Tool
Choice Mode - The tool choice mode.
- Tool
Choice Specific - A specific tool the model is forced to call.
- Truncation
- The truncation strategy to use when the input exceeds the model’s context window.