order, only, ignore, allow_fallbacks), data policy routing preferences (zdr, data_collection) and provider-specific passthrough options
Example Usage
import { STTRequestProvider } from "@openrouter/sdk/models";
let value: STTRequestProvider = {};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
allowFallbacks | boolean | ➖ | Whether to allow backup providers to serve requests - true: (default) when the primary provider (or your custom providers in “order”) is unavailable, use the next best provider. - false: use only the primary/custom provider, and return the upstream error if it’s unavailable. | |
dataCollection | models.STTRequestDataCollection | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error. - allow: (default) allow providers which store user data non-transiently and may train on it - deny: use only providers which do not collect user data. | allow |
ignore | models.STTRequestIgnore[] | ➖ | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [ “openai”, “anthropic” ] |
only | models.STTRequestOnly[] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [ “openai”, “anthropic” ] |
options | models.ProviderOptions | ➖ | Provider-specific options keyed by provider slug. The provider segment is case-insensitive; an endpoint tag after / must match the endpoint slug exactly. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | { “openai”: { “max_tokens”: 1000 } } |
order | models.STTRequestOrder[] | ➖ | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [ “openai”, “anthropic” ] |
zdr | boolean | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true |