@openrouter/sdk 0.13.45 → 0.13.46

package/esm/models/imagegenerationproviderpreferences.d.ts

@@ -0,0 +1,811 @@
+import * as z from "zod/v4";
+import { ProviderName } from "./providername.js";
+import { ProviderSort } from "./providersort.js";
+import { ProviderSortConfig, ProviderSortConfig$Outbound } from "./providersortconfig.js";
+export type ImageGenerationProviderPreferencesIgnore = ProviderName | string;
+export type ImageGenerationProviderPreferencesOnly = ProviderName | string;
+/**
+ * Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped.
+ */
+export type ImageGenerationProviderPreferencesOptions = {
+    oneai?: {
+        [k: string]: any | null;
+    } | undefined;
+    ai21?: {
+        [k: string]: any | null;
+    } | undefined;
+    aionLabs?: {
+        [k: string]: any | null;
+    } | undefined;
+    akashml?: {
+        [k: string]: any | null;
+    } | undefined;
+    alibaba?: {
+        [k: string]: any | null;
+    } | undefined;
+    amazonBedrock?: {
+        [k: string]: any | null;
+    } | undefined;
+    amazonNova?: {
+        [k: string]: any | null;
+    } | undefined;
+    ambient?: {
+        [k: string]: any | null;
+    } | undefined;
+    anthropic?: {
+        [k: string]: any | null;
+    } | undefined;
+    anyscale?: {
+        [k: string]: any | null;
+    } | undefined;
+    arceeAi?: {
+        [k: string]: any | null;
+    } | undefined;
+    atlasCloud?: {
+        [k: string]: any | null;
+    } | undefined;
+    atoma?: {
+        [k: string]: any | null;
+    } | undefined;
+    avian?: {
+        [k: string]: any | null;
+    } | undefined;
+    azure?: {
+        [k: string]: any | null;
+    } | undefined;
+    baidu?: {
+        [k: string]: any | null;
+    } | undefined;
+    baseten?: {
+        [k: string]: any | null;
+    } | undefined;
+    blackForestLabs?: {
+        [k: string]: any | null;
+    } | undefined;
+    byteplus?: {
+        [k: string]: any | null;
+    } | undefined;
+    centml?: {
+        [k: string]: any | null;
+    } | undefined;
+    cerebras?: {
+        [k: string]: any | null;
+    } | undefined;
+    chutes?: {
+        [k: string]: any | null;
+    } | undefined;
+    cirrascale?: {
+        [k: string]: any | null;
+    } | undefined;
+    clarifai?: {
+        [k: string]: any | null;
+    } | undefined;
+    cloudflare?: {
+        [k: string]: any | null;
+    } | undefined;
+    cohere?: {
+        [k: string]: any | null;
+    } | undefined;
+    crofai?: {
+        [k: string]: any | null;
+    } | undefined;
+    crucible?: {
+        [k: string]: any | null;
+    } | undefined;
+    crusoe?: {
+        [k: string]: any | null;
+    } | undefined;
+    darkbloom?: {
+        [k: string]: any | null;
+    } | undefined;
+    decart?: {
+        [k: string]: any | null;
+    } | undefined;
+    deepgram?: {
+        [k: string]: any | null;
+    } | undefined;
+    deepinfra?: {
+        [k: string]: any | null;
+    } | undefined;
+    deepseek?: {
+        [k: string]: any | null;
+    } | undefined;
+    dekallm?: {
+        [k: string]: any | null;
+    } | undefined;
+    digitalocean?: {
+        [k: string]: any | null;
+    } | undefined;
+    enfer?: {
+        [k: string]: any | null;
+    } | undefined;
+    fakeProvider?: {
+        [k: string]: any | null;
+    } | undefined;
+    featherless?: {
+        [k: string]: any | null;
+    } | undefined;
+    fireworks?: {
+        [k: string]: any | null;
+    } | undefined;
+    friendli?: {
+        [k: string]: any | null;
+    } | undefined;
+    gmicloud?: {
+        [k: string]: any | null;
+    } | undefined;
+    googleAiStudio?: {
+        [k: string]: any | null;
+    } | undefined;
+    googleVertex?: {
+        [k: string]: any | null;
+    } | undefined;
+    gopomelo?: {
+        [k: string]: any | null;
+    } | undefined;
+    groq?: {
+        [k: string]: any | null;
+    } | undefined;
+    heygen?: {
+        [k: string]: any | null;
+    } | undefined;
+    huggingface?: {
+        [k: string]: any | null;
+    } | undefined;
+    hyperbolic?: {
+        [k: string]: any | null;
+    } | undefined;
+    hyperbolicQuantized?: {
+        [k: string]: any | null;
+    } | undefined;
+    inception?: {
+        [k: string]: any | null;
+    } | undefined;
+    inceptron?: {
+        [k: string]: any | null;
+    } | undefined;
+    inferactVllm?: {
+        [k: string]: any | null;
+    } | undefined;
+    inferenceNet?: {
+        [k: string]: any | null;
+    } | undefined;
+    infermatic?: {
+        [k: string]: any | null;
+    } | undefined;
+    inflection?: {
+        [k: string]: any | null;
+    } | undefined;
+    inocloud?: {
+        [k: string]: any | null;
+    } | undefined;
+    ioNet?: {
+        [k: string]: any | null;
+    } | undefined;
+    ionstream?: {
+        [k: string]: any | null;
+    } | undefined;
+    klusterai?: {
+        [k: string]: any | null;
+    } | undefined;
+    lambda?: {
+        [k: string]: any | null;
+    } | undefined;
+    lepton?: {
+        [k: string]: any | null;
+    } | undefined;
+    liquid?: {
+        [k: string]: any | null;
+    } | undefined;
+    lynn?: {
+        [k: string]: any | null;
+    } | undefined;
+    lynnPrivate?: {
+        [k: string]: any | null;
+    } | undefined;
+    mancer?: {
+        [k: string]: any | null;
+    } | undefined;
+    mancerOld?: {
+        [k: string]: any | null;
+    } | undefined;
+    mara?: {
+        [k: string]: any | null;
+    } | undefined;
+    meta?: {
+        [k: string]: any | null;
+    } | undefined;
+    minimax?: {
+        [k: string]: any | null;
+    } | undefined;
+    mistral?: {
+        [k: string]: any | null;
+    } | undefined;
+    modal?: {
+        [k: string]: any | null;
+    } | undefined;
+    modelrun?: {
+        [k: string]: any | null;
+    } | undefined;
+    modular?: {
+        [k: string]: any | null;
+    } | undefined;
+    moonshotai?: {
+        [k: string]: any | null;
+    } | undefined;
+    morph?: {
+        [k: string]: any | null;
+    } | undefined;
+    ncompass?: {
+        [k: string]: any | null;
+    } | undefined;
+    nebius?: {
+        [k: string]: any | null;
+    } | undefined;
+    nexAgi?: {
+        [k: string]: any | null;
+    } | undefined;
+    nextbit?: {
+        [k: string]: any | null;
+    } | undefined;
+    nineteen?: {
+        [k: string]: any | null;
+    } | undefined;
+    novita?: {
+        [k: string]: any | null;
+    } | undefined;
+    nvidia?: {
+        [k: string]: any | null;
+    } | undefined;
+    octoai?: {
+        [k: string]: any | null;
+    } | undefined;
+    openInference?: {
+        [k: string]: any | null;
+    } | undefined;
+    openai?: {
+        [k: string]: any | null;
+    } | undefined;
+    parasail?: {
+        [k: string]: any | null;
+    } | undefined;
+    perceptron?: {
+        [k: string]: any | null;
+    } | undefined;
+    perplexity?: {
+        [k: string]: any | null;
+    } | undefined;
+    phala?: {
+        [k: string]: any | null;
+    } | undefined;
+    poolside?: {
+        [k: string]: any | null;
+    } | undefined;
+    quiver?: {
+        [k: string]: any | null;
+    } | undefined;
+    recraft?: {
+        [k: string]: any | null;
+    } | undefined;
+    recursal?: {
+        [k: string]: any | null;
+    } | undefined;
+    reflection?: {
+        [k: string]: any | null;
+    } | undefined;
+    reka?: {
+        [k: string]: any | null;
+    } | undefined;
+    relace?: {
+        [k: string]: any | null;
+    } | undefined;
+    replicate?: {
+        [k: string]: any | null;
+    } | undefined;
+    sakana?: {
+        [k: string]: any | null;
+    } | undefined;
+    sambanova?: {
+        [k: string]: any | null;
+    } | undefined;
+    sambanovaCloaked?: {
+        [k: string]: any | null;
+    } | undefined;
+    seed?: {
+        [k: string]: any | null;
+    } | undefined;
+    sfCompute?: {
+        [k: string]: any | null;
+    } | undefined;
+    siliconflow?: {
+        [k: string]: any | null;
+    } | undefined;
+    sourceful?: {
+        [k: string]: any | null;
+    } | undefined;
+    stealth?: {
+        [k: string]: any | null;
+    } | undefined;
+    stepfun?: {
+        [k: string]: any | null;
+    } | undefined;
+    streamlake?: {
+        [k: string]: any | null;
+    } | undefined;
+    switchpoint?: {
+        [k: string]: any | null;
+    } | undefined;
+    targon?: {
+        [k: string]: any | null;
+    } | undefined;
+    tenstorrent?: {
+        [k: string]: any | null;
+    } | undefined;
+    together?: {
+        [k: string]: any | null;
+    } | undefined;
+    togetherLite?: {
+        [k: string]: any | null;
+    } | undefined;
+    ubicloud?: {
+        [k: string]: any | null;
+    } | undefined;
+    upstage?: {
+        [k: string]: any | null;
+    } | undefined;
+    venice?: {
+        [k: string]: any | null;
+    } | undefined;
+    wafer?: {
+        [k: string]: any | null;
+    } | undefined;
+    wandb?: {
+        [k: string]: any | null;
+    } | undefined;
+    xai?: {
+        [k: string]: any | null;
+    } | undefined;
+    xiaomi?: {
+        [k: string]: any | null;
+    } | undefined;
+    zAi?: {
+        [k: string]: any | null;
+    } | undefined;
+};
+export type ImageGenerationProviderPreferencesOrder = ProviderName | string;
+/**
+ * The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
+ */
+export type ImageGenerationProviderPreferencesSort = ProviderSort | ProviderSortConfig | any;
+/**
+ * Provider routing preferences and provider-specific passthrough configuration.
+ */
+export type ImageGenerationProviderPreferences = {
+    /**
+     * Whether to allow backup providers to serve requests
+     *
+     * @remarks
+     * - 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.
+     */
+    allowFallbacks?: boolean | null | undefined;
+    /**
+     * List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request.
+     */
+    ignore?: Array<ProviderName | string> | null | undefined;
+    /**
+     * List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request.
+     */
+    only?: Array<ProviderName | string> | null | undefined;
+    options?: ImageGenerationProviderPreferencesOptions | undefined;
+    /**
+     * 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.
+     */
+    order?: Array<ProviderName | string> | null | undefined;
+    /**
+     * The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
+     */
+    sort?: ProviderSort | ProviderSortConfig | any | null | undefined;
+};
+/** @internal */
+export type ImageGenerationProviderPreferencesIgnore$Outbound = string | string;
+/** @internal */
+export declare const ImageGenerationProviderPreferencesIgnore$outboundSchema: z.ZodType<ImageGenerationProviderPreferencesIgnore$Outbound, ImageGenerationProviderPreferencesIgnore>;
+export declare function imageGenerationProviderPreferencesIgnoreToJSON(imageGenerationProviderPreferencesIgnore: ImageGenerationProviderPreferencesIgnore): string;
+/** @internal */
+export type ImageGenerationProviderPreferencesOnly$Outbound = string | string;
+/** @internal */
+export declare const ImageGenerationProviderPreferencesOnly$outboundSchema: z.ZodType<ImageGenerationProviderPreferencesOnly$Outbound, ImageGenerationProviderPreferencesOnly>;
+export declare function imageGenerationProviderPreferencesOnlyToJSON(imageGenerationProviderPreferencesOnly: ImageGenerationProviderPreferencesOnly): string;
+/** @internal */
+export type ImageGenerationProviderPreferencesOptions$Outbound = {
+    "01ai"?: {
+        [k: string]: any | null;
+    } | undefined;
+    ai21?: {
+        [k: string]: any | null;
+    } | undefined;
+    "aion-labs"?: {
+        [k: string]: any | null;
+    } | undefined;
+    akashml?: {
+        [k: string]: any | null;
+    } | undefined;
+    alibaba?: {
+        [k: string]: any | null;
+    } | undefined;
+    "amazon-bedrock"?: {
+        [k: string]: any | null;
+    } | undefined;
+    "amazon-nova"?: {
+        [k: string]: any | null;
+    } | undefined;
+    ambient?: {
+        [k: string]: any | null;
+    } | undefined;
+    anthropic?: {
+        [k: string]: any | null;
+    } | undefined;
+    anyscale?: {
+        [k: string]: any | null;
+    } | undefined;
+    "arcee-ai"?: {
+        [k: string]: any | null;
+    } | undefined;
+    "atlas-cloud"?: {
+        [k: string]: any | null;
+    } | undefined;
+    atoma?: {
+        [k: string]: any | null;
+    } | undefined;
+    avian?: {
+        [k: string]: any | null;
+    } | undefined;
+    azure?: {
+        [k: string]: any | null;
+    } | undefined;
+    baidu?: {
+        [k: string]: any | null;
+    } | undefined;
+    baseten?: {
+        [k: string]: any | null;
+    } | undefined;
+    "black-forest-labs"?: {
+        [k: string]: any | null;
+    } | undefined;
+    byteplus?: {
+        [k: string]: any | null;
+    } | undefined;
+    centml?: {
+        [k: string]: any | null;
+    } | undefined;
+    cerebras?: {
+        [k: string]: any | null;
+    } | undefined;
+    chutes?: {
+        [k: string]: any | null;
+    } | undefined;
+    cirrascale?: {
+        [k: string]: any | null;
+    } | undefined;
+    clarifai?: {
+        [k: string]: any | null;
+    } | undefined;
+    cloudflare?: {
+        [k: string]: any | null;
+    } | undefined;
+    cohere?: {
+        [k: string]: any | null;
+    } | undefined;
+    crofai?: {
+        [k: string]: any | null;
+    } | undefined;
+    crucible?: {
+        [k: string]: any | null;
+    } | undefined;
+    crusoe?: {
+        [k: string]: any | null;
+    } | undefined;
+    darkbloom?: {
+        [k: string]: any | null;
+    } | undefined;
+    decart?: {
+        [k: string]: any | null;
+    } | undefined;
+    deepgram?: {
+        [k: string]: any | null;
+    } | undefined;
+    deepinfra?: {
+        [k: string]: any | null;
+    } | undefined;
+    deepseek?: {
+        [k: string]: any | null;
+    } | undefined;
+    dekallm?: {
+        [k: string]: any | null;
+    } | undefined;
+    digitalocean?: {
+        [k: string]: any | null;
+    } | undefined;
+    enfer?: {
+        [k: string]: any | null;
+    } | undefined;
+    "fake-provider"?: {
+        [k: string]: any | null;
+    } | undefined;
+    featherless?: {
+        [k: string]: any | null;
+    } | undefined;
+    fireworks?: {
+        [k: string]: any | null;
+    } | undefined;
+    friendli?: {
+        [k: string]: any | null;
+    } | undefined;
+    gmicloud?: {
+        [k: string]: any | null;
+    } | undefined;
+    "google-ai-studio"?: {
+        [k: string]: any | null;
+    } | undefined;
+    "google-vertex"?: {
+        [k: string]: any | null;
+    } | undefined;
+    gopomelo?: {
+        [k: string]: any | null;
+    } | undefined;
+    groq?: {
+        [k: string]: any | null;
+    } | undefined;
+    heygen?: {
+        [k: string]: any | null;
+    } | undefined;
+    huggingface?: {
+        [k: string]: any | null;
+    } | undefined;
+    hyperbolic?: {
+        [k: string]: any | null;
+    } | undefined;
+    "hyperbolic-quantized"?: {
+        [k: string]: any | null;
+    } | undefined;
+    inception?: {
+        [k: string]: any | null;
+    } | undefined;
+    inceptron?: {
+        [k: string]: any | null;
+    } | undefined;
+    "inferact-vllm"?: {
+        [k: string]: any | null;
+    } | undefined;
+    "inference-net"?: {
+        [k: string]: any | null;
+    } | undefined;
+    infermatic?: {
+        [k: string]: any | null;
+    } | undefined;
+    inflection?: {
+        [k: string]: any | null;
+    } | undefined;
+    inocloud?: {
+        [k: string]: any | null;
+    } | undefined;
+    "io-net"?: {
+        [k: string]: any | null;
+    } | undefined;
+    ionstream?: {
+        [k: string]: any | null;
+    } | undefined;
+    klusterai?: {
+        [k: string]: any | null;
+    } | undefined;
+    lambda?: {
+        [k: string]: any | null;
+    } | undefined;
+    lepton?: {
+        [k: string]: any | null;
+    } | undefined;
+    liquid?: {
+        [k: string]: any | null;
+    } | undefined;
+    lynn?: {
+        [k: string]: any | null;
+    } | undefined;
+    "lynn-private"?: {
+        [k: string]: any | null;
+    } | undefined;
+    mancer?: {
+        [k: string]: any | null;
+    } | undefined;
+    "mancer-old"?: {
+        [k: string]: any | null;
+    } | undefined;
+    mara?: {
+        [k: string]: any | null;
+    } | undefined;
+    meta?: {
+        [k: string]: any | null;
+    } | undefined;
+    minimax?: {
+        [k: string]: any | null;
+    } | undefined;
+    mistral?: {
+        [k: string]: any | null;
+    } | undefined;
+    modal?: {
+        [k: string]: any | null;
+    } | undefined;
+    modelrun?: {
+        [k: string]: any | null;
+    } | undefined;
+    modular?: {
+        [k: string]: any | null;
+    } | undefined;
+    moonshotai?: {
+        [k: string]: any | null;
+    } | undefined;
+    morph?: {
+        [k: string]: any | null;
+    } | undefined;
+    ncompass?: {
+        [k: string]: any | null;
+    } | undefined;
+    nebius?: {
+        [k: string]: any | null;
+    } | undefined;
+    "nex-agi"?: {
+        [k: string]: any | null;
+    } | undefined;
+    nextbit?: {
+        [k: string]: any | null;
+    } | undefined;
+    nineteen?: {
+        [k: string]: any | null;
+    } | undefined;
+    novita?: {
+        [k: string]: any | null;
+    } | undefined;
+    nvidia?: {
+        [k: string]: any | null;
+    } | undefined;
+    octoai?: {
+        [k: string]: any | null;
+    } | undefined;
+    "open-inference"?: {
+        [k: string]: any | null;
+    } | undefined;
+    openai?: {
+        [k: string]: any | null;
+    } | undefined;
+    parasail?: {
+        [k: string]: any | null;
+    } | undefined;
+    perceptron?: {
+        [k: string]: any | null;
+    } | undefined;
+    perplexity?: {
+        [k: string]: any | null;
+    } | undefined;
+    phala?: {
+        [k: string]: any | null;
+    } | undefined;
+    poolside?: {
+        [k: string]: any | null;
+    } | undefined;
+    quiver?: {
+        [k: string]: any | null;
+    } | undefined;
+    recraft?: {
+        [k: string]: any | null;
+    } | undefined;
+    recursal?: {
+        [k: string]: any | null;
+    } | undefined;
+    reflection?: {
+        [k: string]: any | null;
+    } | undefined;
+    reka?: {
+        [k: string]: any | null;
+    } | undefined;
+    relace?: {
+        [k: string]: any | null;
+    } | undefined;
+    replicate?: {
+        [k: string]: any | null;
+    } | undefined;
+    sakana?: {
+        [k: string]: any | null;
+    } | undefined;
+    sambanova?: {
+        [k: string]: any | null;
+    } | undefined;
+    "sambanova-cloaked"?: {
+        [k: string]: any | null;
+    } | undefined;
+    seed?: {
+        [k: string]: any | null;
+    } | undefined;
+    "sf-compute"?: {
+        [k: string]: any | null;
+    } | undefined;
+    siliconflow?: {
+        [k: string]: any | null;
+    } | undefined;
+    sourceful?: {
+        [k: string]: any | null;
+    } | undefined;
+    stealth?: {
+        [k: string]: any | null;
+    } | undefined;
+    stepfun?: {
+        [k: string]: any | null;
+    } | undefined;
+    streamlake?: {
+        [k: string]: any | null;
+    } | undefined;
+    switchpoint?: {
+        [k: string]: any | null;
+    } | undefined;
+    targon?: {
+        [k: string]: any | null;
+    } | undefined;
+    tenstorrent?: {
+        [k: string]: any | null;
+    } | undefined;
+    together?: {
+        [k: string]: any | null;
+    } | undefined;
+    "together-lite"?: {
+        [k: string]: any | null;
+    } | undefined;
+    ubicloud?: {
+        [k: string]: any | null;
+    } | undefined;
+    upstage?: {
+        [k: string]: any | null;
+    } | undefined;
+    venice?: {
+        [k: string]: any | null;
+    } | undefined;
+    wafer?: {
+        [k: string]: any | null;
+    } | undefined;
+    wandb?: {
+        [k: string]: any | null;
+    } | undefined;
+    xai?: {
+        [k: string]: any | null;
+    } | undefined;
+    xiaomi?: {
+        [k: string]: any | null;
+    } | undefined;
+    "z-ai"?: {
+        [k: string]: any | null;
+    } | undefined;
+};
+/** @internal */
+export declare const ImageGenerationProviderPreferencesOptions$outboundSchema: z.ZodType<ImageGenerationProviderPreferencesOptions$Outbound, ImageGenerationProviderPreferencesOptions>;
+export declare function imageGenerationProviderPreferencesOptionsToJSON(imageGenerationProviderPreferencesOptions: ImageGenerationProviderPreferencesOptions): string;
+/** @internal */
+export type ImageGenerationProviderPreferencesOrder$Outbound = string | string;
+/** @internal */
+export declare const ImageGenerationProviderPreferencesOrder$outboundSchema: z.ZodType<ImageGenerationProviderPreferencesOrder$Outbound, ImageGenerationProviderPreferencesOrder>;
+export declare function imageGenerationProviderPreferencesOrderToJSON(imageGenerationProviderPreferencesOrder: ImageGenerationProviderPreferencesOrder): string;
+/** @internal */
+export type ImageGenerationProviderPreferencesSort$Outbound = string | ProviderSortConfig$Outbound | any;
+/** @internal */
+export declare const ImageGenerationProviderPreferencesSort$outboundSchema: z.ZodType<ImageGenerationProviderPreferencesSort$Outbound, ImageGenerationProviderPreferencesSort>;
+export declare function imageGenerationProviderPreferencesSortToJSON(imageGenerationProviderPreferencesSort: ImageGenerationProviderPreferencesSort): string;
+/** @internal */
+export type ImageGenerationProviderPreferences$Outbound = {
+    allow_fallbacks?: boolean | null | undefined;
+    ignore?: Array<string | string> | null | undefined;
+    only?: Array<string | string> | null | undefined;
+    options?: ImageGenerationProviderPreferencesOptions$Outbound | undefined;
+    order?: Array<string | string> | null | undefined;
+    sort?: string | ProviderSortConfig$Outbound | any | null | undefined;
+};
+/** @internal */
+export declare const ImageGenerationProviderPreferences$outboundSchema: z.ZodType<ImageGenerationProviderPreferences$Outbound, ImageGenerationProviderPreferences>;
+export declare function imageGenerationProviderPreferencesToJSON(imageGenerationProviderPreferences: ImageGenerationProviderPreferences): string;
+//# sourceMappingURL=imagegenerationproviderpreferences.d.ts.map