Example Usage
import { ImageGenerationProviderPreferences } from "@openrouter/sdk/models";
let value: ImageGenerationProviderPreferences = {};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
allowFallbacks | boolean | :heavy_minus_sign: | 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. | |
ignore | models.ImageGenerationProviderPreferencesIgnore[] | :heavy_minus_sign: | 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.ImageGenerationProviderPreferencesOnly[] | :heavy_minus_sign: | 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.ImageGenerationProviderPreferencesOptions | :heavy_minus_sign: | N/A | { “black-forest-labs”: { “guidance”: 3, “steps”: 40 } } |
order | models.ImageGenerationProviderPreferencesOrder[] | :heavy_minus_sign: | 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” ] |
sort | models.ImageGenerationProviderPreferencesSort | :heavy_minus_sign: | The sorting strategy to use for this request, if “order” is not specified. When set, no load balancing is performed. | price |