ResponsesRequest
| Property | Type | Required | Description |
|---|---|---|---|
model | string | Yes | Model ID used to generate the response, like llama3.1:8b or qwen3:1.7b.DeepFellow supports a wide range of models with different capabilities, and performance characteristics. |
input | string | Message | InputMessage | OutputMessage-Input | FileSearchToolCall | FunctionToolCall | CustomToolCall | Reasoning | ImageGenerationCall | McpListTools | McpApprovalRequest | McpApprovalResponse | ItemReference | McpToolCall | FunctionCallOutput | CustomToolCallOutput | WebSearchCall-Input | Compaction | ToolSearchCall | ToolSearchOutput-Input | ApplyPatchToolCall | ApplyPatchToolCallOutput[] | No | Text, image, or file inputs to the model, used to generate a response. Default: []. |
instructions | string | No | Previous messages inserted into the model's context.When using along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses. Default: "". |
text | TextConfig | null | No | Configuration options for a text response from the model. Can be plain text, JSON or structured JSON. |
prompt | Prompt | null | No | Reference to a prompt template and its variables. |
tool_choice | enum | HostedToolChoice | McpToolChoice | No | [Currently not supported] How the model should select which tool (or tools) to use when generating a response. See the tools parameter below to see how to specify which tools the model can call. Default: "auto". |
tools | object | FunctionDef[] | No | An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.We support the following categories of tools:- Built-in tools: Tools that are provided by DeepFellow that extend the model's capabilities, like web search or file search.- MCP Tools: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint.- Function calls (custom tools): Functions that are defined by you, enabling the model to call your own code with strongly typed arguments and outputs. You can also use custom tools to call your own code. Default: []. |
temperature | number | No | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both. Default: 1. |
top_p | number | No | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.We generally recommend altering this or temperature but not both. Default: 1. |
reasoning | ReasoningConfig | null | No | Configuration options for reasoning models. |
stream | boolean | No | If set to true, the model response data will be streamed to the client as it is generated using server-sent events. Default: false. |
max_output_tokens | integer | null | No | An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens. |
max_tool_calls | integer | No | The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored. Default: 5. |
parallel_tool_calls | boolean | No | Whether to allow the model to run tool calls in parallel. Default: false. |
include | object[] | No | Specify additional output data to include in the model response. Default: []. |
background | boolean | No | Whether to run the model response in the background. Default: false. |
previous_response_id | string | No | [Currently not supported] The unique ID of the previous response to the model. Use this to create multi-turn conversations. Cannot be used in conjunction with conversation. Default: "". |
top_logprobs | integer | null | No | An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. |
metadata | object | No | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Default: {}. |
service_tier | enum | No | [Not supported. Placeholder for compatibility] One of: auto, default, flex, priority. Default: "auto". |
store | boolean | No | [Currently not supported] Whether to store the generated model response for later retrieval via API. Default: true. |
truncation | enum | No | [Currently not supported] The truncation strategy to use for the model response.- auto: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation.- disabled (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error. One of: auto, disabled. Default: "disabled". |
user | string | No | This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Default: "". |
We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.