Trait CompatFamilySpec 

pub trait CompatFamilySpec {
    const DISPLAY: &'static str;
    const DEFAULT_URL: &'static str;
    const AUTH: AuthStyle;
    const MODELS_DEV_KEY: Option<&'static str> = None;
    const OPENROUTER_VENDOR_PREFIX: Option<&'static str> = None;
    const PUBLIC_MODEL_LISTING: bool = false;

    // Provided methods
    fn wire_api(&self) -> Option<WireApi> { ... }
    fn build_compat_base(
        &self,
        alias: &str,
        key: Option<&str>,
        api_url: Option<&str>,
    ) -> OpenAiCompatibleModelProvider { ... }
    fn build_compat(
        &self,
        alias: &str,
        key: Option<&str>,
        api_url: Option<&str>,
    ) -> OpenAiCompatibleModelProvider { ... }
}

Spec trait for OpenAI-compatible families. Implementing this gives a FamilyProviderFactory impl for free via the blanket below.

Override CompatFamilySpec::build_compat when the family needs minor modifiers (e.g. .without_native_tools()); otherwise the default OpenAiCompatibleModelProvider::new constructor is used.

Required Associated Constants

const DISPLAY: &'static str

const DEFAULT_URL: &'static str

const AUTH: AuthStyle

Provided Associated Constants

const MODELS_DEV_KEY: Option<&'static str> = None

models.dev catalog key for this provider, when present in the public catalog. Lets list_models() pre-populate the model picker without a credential — the gateway and TUI both surface the cataloged IDs even before the operator pastes their API key. Set to None for providers that don’t have a models.dev entry; their picker stays empty until a credential unlocks the live /models endpoint, which the dashboard already falls back to a free-text input for.

const OPENROUTER_VENDOR_PREFIX: Option<&'static str> = None

OpenRouter vendor prefix used by list_models as a last-resort fallback when this family has no models.dev entry and no live credential. None when no OpenRouter prefix exists for this family (e.g. Sambanova, Hyperbolic — no public catalog at all without a key).

const PUBLIC_MODEL_LISTING: bool = false

Whether this provider’s /models endpoint is accessible without an API key. When true, list_models() and list_models_with_pricing() will query the live endpoint even when no credential is configured. Defaults to false; set to true for providers like Kilo Gateway whose model catalog is public.

Provided Methods

fn wire_api(&self) -> Option<WireApi>

Wire protocol selector for this entry, when the family reads it from per-alias config. Defaults to None so families that only speak chat_completions need no override.

A family whose endpoint can serve the responses wire MUST override this to return self.base.wire_api; otherwise a user’s wire_api = "responses" is silently ignored and routed through chat_completions. The blanket create_provider consults this before building the compat client.

fn build_compat_base( &self, alias: &str, key: Option<&str>, api_url: Option<&str>, ) -> OpenAiCompatibleModelProvider

Build the base compat provider with both catalog consts applied. Use this from inside build_compat overrides so the catalog hooks ride along with any family-specific modifiers.

fn build_compat( &self, alias: &str, key: Option<&str>, api_url: Option<&str>, ) -> OpenAiCompatibleModelProvider

Build the underlying compat provider. Default just returns the base from build_compat_base; override to chain family-specific modifiers (e.g. .without_native_tools(), .with_merge_system_into_user()).

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl CompatFamilySpec for Ai21ModelProviderConfig

const DISPLAY: &'static str = "AI21 Labs"

const DEFAULT_URL: &'static str = "https://api.ai21.com/studio/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

impl CompatFamilySpec for AihubmixModelProviderConfig

const DISPLAY: &'static str = "AiHubMix"

const DEFAULT_URL: &'static str = "https://aihubmix.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for AnyscaleModelProviderConfig

const DISPLAY: &'static str = "Anyscale"

const DEFAULT_URL: &'static str = "https://api.endpoints.anyscale.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for ArceeModelProviderConfig

const DISPLAY: &'static str = "Arcee AI"

const DEFAULT_URL: &'static str = "https://api.arcee.ai/api/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for AstraiModelProviderConfig

const DISPLAY: &'static str = "Astrai"

const DEFAULT_URL: &'static str = "https://as-trai.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for AtomicChatModelProviderConfig

const DEFAULT_URL: &'static str = "http://127.0.0.1:1337/v1"

Default endpoint for the Jan / Atomic Chat local OpenAI-compatible runtime (jan.ai). Operators override via api_url on the alias entry when they run it on a non-default port.

const DISPLAY: &'static str = "Atomic Chat"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

fn build_compat( &self, alias: &str, key: Option<&str>, api_url: Option<&str>, ) -> OpenAiCompatibleModelProvider

impl CompatFamilySpec for AvianModelProviderConfig

const DISPLAY: &'static str = "Avian"

const DEFAULT_URL: &'static str = "https://api.avian.io/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for BaichuanModelProviderConfig

const DISPLAY: &'static str = "Baichuan"

const DEFAULT_URL: &'static str = "https://api.baichuan-ai.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for BasetenModelProviderConfig

const DISPLAY: &'static str = "Baseten"

const DEFAULT_URL: &'static str = "https://inference.baseten.co/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for CerebrasModelProviderConfig

const DISPLAY: &'static str = "Cerebras"

const DEFAULT_URL: &'static str = "https://api.cerebras.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for CloudflareModelProviderConfig

const DISPLAY: &'static str = "Cloudflare AI Gateway"

const DEFAULT_URL: &'static str = "https://gateway.ai.cloudflare.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for CohereModelProviderConfig

const DISPLAY: &'static str = "Cohere"

const DEFAULT_URL: &'static str = "https://api.cohere.com/compatibility"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for DeepinfraModelProviderConfig

const DISPLAY: &'static str = "DeepInfra"

const DEFAULT_URL: &'static str = "https://api.deepinfra.com/v1/openai"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for DeepmystModelProviderConfig

const DISPLAY: &'static str = "DeepMyst"

const DEFAULT_URL: &'static str = "https://api.deepmyst.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for DeepseekModelProviderConfig

const DISPLAY: &'static str = "DeepSeek"

const DEFAULT_URL: &'static str = "https://api.deepseek.com"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for DoubaoModelProviderConfig

const DISPLAY: &'static str = "Doubao"

const DEFAULT_URL: &'static str = "https://ark.cn-beijing.volces.com/api/v3"

const AUTH: AuthStyle = AuthStyle::Bearer

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

impl CompatFamilySpec for FeatherlessModelProviderConfig

const DISPLAY: &'static str = "Featherless AI"

const DEFAULT_URL: &'static str = "https://api.featherless.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for FireworksModelProviderConfig

const DISPLAY: &'static str = "Fireworks AI"

const DEFAULT_URL: &'static str = "https://api.fireworks.ai/inference/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for FriendliModelProviderConfig

const DISPLAY: &'static str = "Friendli AI"

const DEFAULT_URL: &'static str = "https://api.friendli.ai/serverless/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for GithubModelsModelProviderConfig

const DISPLAY: &'static str = "GitHub Models"

const DEFAULT_URL: &'static str = "https://models.github.ai/inference"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for GlmModelProviderConfig

const DISPLAY: &'static str = "GLM"

const DEFAULT_URL: &'static str = crate::GLM_GLOBAL_BASE_URL

const AUTH: AuthStyle = AuthStyle::ZhipuJwt

const MODELS_DEV_KEY: Option<&'static str>

fn build_compat( &self, alias: &str, key: Option<&str>, api_url: Option<&str>, ) -> OpenAiCompatibleModelProvider

impl CompatFamilySpec for HuggingfaceModelProviderConfig

const DISPLAY: &'static str = "Hugging Face"

const DEFAULT_URL: &'static str = "https://router.huggingface.co/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for HunyuanModelProviderConfig

const DISPLAY: &'static str = "Tencent Hunyuan"

const DEFAULT_URL: &'static str = "https://api.hunyuan.cloud.tencent.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

impl CompatFamilySpec for HyperbolicModelProviderConfig

const DISPLAY: &'static str = "Hyperbolic"

const DEFAULT_URL: &'static str = "https://api.hyperbolic.xyz/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for InceptionModelProviderConfig

const DISPLAY: &'static str = "Inception Labs"

const DEFAULT_URL: &'static str = "https://api.inceptionlabs.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for KiloModelProviderConfig

const DISPLAY: &'static str = "Kilo"

const DEFAULT_URL: &'static str = "https://api.kilo.ai/api/gateway"

const AUTH: AuthStyle = AuthStyle::Bearer

const PUBLIC_MODEL_LISTING: bool = true

impl CompatFamilySpec for LambdaAiModelProviderConfig

const DISPLAY: &'static str = "Lambda AI"

const DEFAULT_URL: &'static str = "https://api.lambda.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for LeptonModelProviderConfig

const DISPLAY: &'static str = "Lepton AI"

const DEFAULT_URL: &'static str = "https://llama3-1-405b.lepton.run/api/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for LitellmModelProviderConfig

const DISPLAY: &'static str = "LiteLLM"

const DEFAULT_URL: &'static str = "http://localhost:4000/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for MistralModelProviderConfig

const DISPLAY: &'static str = "Mistral"

const DEFAULT_URL: &'static str = "https://api.mistral.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for MoonshotModelProviderConfig

const DISPLAY: &'static str = "Moonshot"

const DEFAULT_URL: &'static str = crate::MOONSHOT_INTL_BASE_URL

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

fn build_compat( &self, alias: &str, key: Option<&str>, api_url: Option<&str>, ) -> OpenAiCompatibleModelProvider

impl CompatFamilySpec for MorphModelProviderConfig

const DISPLAY: &'static str = "Morph"

const DEFAULT_URL: &'static str = "https://api.morphllm.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for NebiusModelProviderConfig

const DISPLAY: &'static str = "Nebius AI Studio"

const DEFAULT_URL: &'static str = "https://api.studio.nebius.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for NovitaModelProviderConfig

const DISPLAY: &'static str = "Novita AI"

const DEFAULT_URL: &'static str = "https://api.novita.ai/openai"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for NscaleModelProviderConfig

const DISPLAY: &'static str = "Nscale"

const DEFAULT_URL: &'static str = "https://inference.api.nscale.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for NvidiaModelProviderConfig

const DISPLAY: &'static str = "NVIDIA NIM"

const DEFAULT_URL: &'static str = "https://integrate.api.nvidia.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

impl CompatFamilySpec for OpencodeModelProviderConfig

const DISPLAY: &'static str = "OpenCode Zen"

const DEFAULT_URL: &'static str = "https://opencode.ai/zen/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

fn wire_api(&self) -> Option<WireApi>

impl CompatFamilySpec for PerplexityModelProviderConfig

const DISPLAY: &'static str = "Perplexity"

const DEFAULT_URL: &'static str = "https://api.perplexity.ai"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for QianfanModelProviderConfig

const DISPLAY: &'static str = "Qianfan"

const DEFAULT_URL: &'static str = "https://qianfan.baidubce.com/v2"

const AUTH: AuthStyle = AuthStyle::Bearer

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

fn build_compat( &self, alias: &str, key: Option<&str>, api_url: Option<&str>, ) -> OpenAiCompatibleModelProvider

impl CompatFamilySpec for RekaModelProviderConfig

const DISPLAY: &'static str = "Reka"

const DEFAULT_URL: &'static str = "https://api.reka.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

impl CompatFamilySpec for SambanovaModelProviderConfig

const DISPLAY: &'static str = "SambaNova"

const DEFAULT_URL: &'static str = "https://api.sambanova.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for SglangModelProviderConfig

const DISPLAY: &'static str = "SGLang"

const DEFAULT_URL: &'static str = "http://localhost:30000/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for SiliconflowModelProviderConfig

const DISPLAY: &'static str = "SiliconFlow"

const DEFAULT_URL: &'static str = "https://api.siliconflow.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for StepfunModelProviderConfig

const DISPLAY: &'static str = "Stepfun"

const DEFAULT_URL: &'static str = "https://api.stepfun.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

impl CompatFamilySpec for SyntheticModelProviderConfig

const DISPLAY: &'static str = "Synthetic"

const DEFAULT_URL: &'static str = "https://api.synthetic.new/openai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for TogetherModelProviderConfig

const DISPLAY: &'static str = "Together AI"

const DEFAULT_URL: &'static str = "https://api.together.xyz"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for UpstageModelProviderConfig

const DISPLAY: &'static str = "Upstage Solar"

const DEFAULT_URL: &'static str = "https://api.upstage.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for VeniceModelProviderConfig

const DISPLAY: &'static str = "Venice"

const DEFAULT_URL: &'static str = "https://api.venice.ai"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

fn build_compat( &self, alias: &str, key: Option<&str>, api_url: Option<&str>, ) -> OpenAiCompatibleModelProvider

impl CompatFamilySpec for VercelModelProviderConfig

const DISPLAY: &'static str = "Vercel AI Gateway"

const DEFAULT_URL: &'static str = crate::VERCEL_AI_GATEWAY_BASE_URL

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for VllmModelProviderConfig

const DISPLAY: &'static str = "vLLM"

const DEFAULT_URL: &'static str = "http://localhost:8000/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for XaiModelProviderConfig

const DISPLAY: &'static str = "xAI"

const DEFAULT_URL: &'static str = "https://api.x.ai/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

const MODELS_DEV_KEY: Option<&'static str>

impl CompatFamilySpec for YiModelProviderConfig

const DISPLAY: &'static str = "01.AI (Yi)"

const DEFAULT_URL: &'static str = "https://api.lingyiwanwu.com/v1"

const AUTH: AuthStyle = AuthStyle::Bearer

impl CompatFamilySpec for ZaiModelProviderConfig

const DISPLAY: &'static str = "Z.AI"

const DEFAULT_URL: &'static str = crate::ZAI_GLOBAL_BASE_URL

const AUTH: AuthStyle = AuthStyle::ZhipuJwt

const MODELS_DEV_KEY: Option<&'static str>

const OPENROUTER_VENDOR_PREFIX: Option<&'static str>

Implementors