Guides

Choose a model

Read your catalog, name models three ways, and compare provider capabilities.

Read the catalog at runtime

GET /v1/models returns the models available to the key that called it. The catalog is scoped per key and changes over time, so read it at runtime instead of hardcoding names. The quickstart has the request.

Two ways to name a model

A model ID pins one exact model. Use an id from GET /v1/models:

{
  "model": "your-model-id",
  "input": "Classify this support request."
}

An explicit list names providers directly and is tried in order. See Add fallbacks.

Provider and model syntax

Entries in a models list use provider:provider-model:

openai:gpt-5.4-mini
fireworks:accounts/fireworks/models/kimi-k2p7-code

Add a service tier as a third segment to pin it, for example openai:gpt-5.4-mini:flex. See Service tiers.

Every candidate must be available to your key.

Capability differences

Streaming, function tools, and JSON Schema output work across providers, subject to model support. Input types differ more:

CapabilityOpenAIFireworks
Image inputModel-dependentModel-dependent
File/document inputNo Router upload APINot supported
Audio inputModel-dependentNot supported
Basic web searchSupportedNot supported

Support varies by model within a provider, so test the features your request actually uses before putting a model into a fallback list.