Example Usage
import { ResponsesRequest } from "@openrouter/sdk/models";
let value: ResponsesRequest = {};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
background | boolean | :heavy_minus_sign: | N/A | |
cacheControl | models.AnthropicCacheControlDirective | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider’s native format. | { “type”: “ephemeral” } |
debug | models.ChatDebugOptions | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | { “echo_upstream_body”: true } |
frequencyPenalty | number | :heavy_minus_sign: | N/A | |
imageConfig | Record<string, models.ImageConfig> | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | { “aspect_ratio”: “16:9”, “quality”: “high” } |
include | models.ResponseIncludesEnum[] | :heavy_minus_sign: | N/A | |
input | models.InputsUnion | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [ { “content”: “What is the weather today?”, “role”: “user” } ] |
instructions | string | :heavy_minus_sign: | N/A | |
maxOutputTokens | number | :heavy_minus_sign: | N/A | |
maxToolCalls | number | :heavy_minus_sign: | Maximum number of server-tool (e.g. openrouter:web_search) agent steps the model may take during a request. Defaults to 30, which is also the maximum. Ignored when stop_server_tools_when is set. | 30 |
metadata | Record<string, string> | :heavy_minus_sign: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | { “session_id”: “abc-def-ghi”, “user_id”: “123” } |
modalities | models.OutputModalityEnum[] | :heavy_minus_sign: | Output modalities for the response. Supported values are “text” and “image”. | [ “text”, “image” ] |
model | string | :heavy_minus_sign: | N/A | |
models | string[] | :heavy_minus_sign: | N/A | |
parallelToolCalls | boolean | :heavy_minus_sign: | N/A | |
plugins | models.ResponsesRequestPlugin[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | |
presencePenalty | number | :heavy_minus_sign: | N/A | |
previousResponseId | any | :heavy_minus_sign: | Not supported. The Responses API is stateless: no responses are stored, so a previous response cannot be referenced. Requests with a non-null value are rejected with a 400 error. Send the full conversation history in input instead. | |
prompt | models.StoredPromptTemplate | :heavy_minus_sign: | N/A | { “id”: “prompt-abc123”, “variables”: { “name”: “John” } } |
promptCacheKey | string | :heavy_minus_sign: | N/A | |
promptCacheOptions | models.PromptCacheOptions | :heavy_minus_sign: | Request-level prompt-cache controls. mode: "explicit" disables OpenAI-managed breakpoints so only blocks marked with prompt_cache_breakpoint are cached. Only supported by OpenAI GPT-5.6 and newer. | { “mode”: “explicit”, “ttl”: “30m” } |
provider | models.ProviderPreferences | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | { “allow_fallbacks”: true } |
reasoning | models.ReasoningConfig | :heavy_minus_sign: | Configuration for reasoning mode in the response | { “enabled”: true, “summary”: “auto” } |
safetyIdentifier | string | :heavy_minus_sign: | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 |
serviceTier | models.ResponsesRequestServiceTier | :heavy_minus_sign: | The service tier to use for processing this request. fast is accepted as an alias for priority. | |
sessionId | string | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | |
stopServerToolsWhen | models.StopServerToolsWhenCondition[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides max_tool_calls. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [ { “step_count”: 5, “type”: “step_count_is” }, { “max_cost_in_dollars”: 0.5, “type”: “max_cost” } ] |
store | false | :heavy_minus_sign: | N/A | |
stream | boolean | :heavy_minus_sign: | N/A | |
temperature | number | :heavy_minus_sign: | N/A | |
text | models.TextExtendedConfig | :heavy_minus_sign: | Text output configuration including format and verbosity | { “format”: { “type”: “text” } } |
toolChoice | models.OpenAIResponsesToolChoiceUnion | :heavy_minus_sign: | N/A | auto |
tools | models.ResponsesRequestToolUnion[] | :heavy_minus_sign: | N/A | |
topK | number | :heavy_minus_sign: | N/A | |
topLogprobs | number | :heavy_minus_sign: | N/A | |
topP | number | :heavy_minus_sign: | N/A | |
trace | models.TraceConfig | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | { “trace_id”: “trace-abc123”, “trace_name”: “my-app-trace” } |
truncation | models.OpenAIResponsesTruncation | :heavy_minus_sign: | N/A | auto |
user | string | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. |