Authentication
Set yourOPENROUTER_API_KEY environment variable. Get your key from here.
Example
UseOpenRouter with your Agent:
Params
| Parameter | Type | Default | Description |
|---|---|---|---|
id | str | "openai/gpt-4o-mini" | The id of the OpenRouter model to use |
name | str | "OpenRouter" | The name of the model |
provider | str | "OpenRouter" | The provider of the model |
api_key | Optional[str] | None | The API key for OpenRouter (defaults to OPENROUTER_API_KEY env var) |
base_url | str | "https://openrouter.ai/api/v1" | The base URL for the OpenRouter API |
app_name | Optional[str] | "agno" | Application name for OpenRouter request headers |
OpenRouter also supports the params of OpenAI.
Responses API
OpenRouter also supports the OpenAI Responses API (currently in beta). UseOpenRouterResponses for this interface:
Fallback Model Routing
OpenRouterResponses supports automatic fallback to alternative models if the primary model fails:
Prompt caching
Prompt caching will happen automatically using ourOpenRouter model, when the used provider supports it. In other cases you can activate it via the cache_control header.
You can read more about prompt caching with OpenRouter in their docs.