recoder-code 1.0.113

package/KILO.md

@@ -0,0 +1,1273 @@
+---
+title: Quickstart
+subtitle: Get started with OpenRouter
+slug: quickstart
+headline: OpenRouter Quickstart Guide | Developer Documentation
+canonical-url: 'https://openrouter.ai/docs/quickstart'
+'og:site_name': OpenRouter Documentation
+'og:title': OpenRouter Quickstart Guide
+'og:description': >-
+  Get started with OpenRouter's unified API for hundreds of AI models. Learn how
+  to integrate using OpenAI SDK, direct API calls, or third-party frameworks.
+'og:image':
+  type: url
+  value: >-
+    https://openrouter.ai/dynamic-og?pathname=quickstart&title=Quick%20Start&description=Start%20using%20OpenRouter%20API%20in%20minutes%20with%20any%20SDK
+'og:image:width': 1200
+'og:image:height': 630
+'twitter:card': summary_large_image
+'twitter:site': '@OpenRouterAI'
+noindex: false
+nofollow: false
+---
+
+OpenRouter provides a unified API that gives you access to hundreds of AI models through a single endpoint, while automatically handling fallbacks and selecting the most cost-effective options. Get started with just a few lines of code using your preferred SDK or framework.
+
+<Tip>
+  Looking for information about free models and rate limits? Please see the [FAQ](/docs/faq#how-are-rate-limits-calculated)
+</Tip>
+
+In the examples below, the OpenRouter-specific headers are optional. Setting them allows your app to appear on the OpenRouter leaderboards. For detailed information about app attribution, see our [App Attribution guide](/docs/features/app-attribution).
+
+## Using the OpenAI SDK
+
+<CodeGroup>
+
+```python title="Python"
+from openai import OpenAI
+
+client = OpenAI(
+  base_url="https://openrouter.ai/api/v1",
+  api_key="<OPENROUTER_API_KEY>",
+)
+
+completion = client.chat.completions.create(
+  extra_headers={
+    "HTTP-Referer": "<YOUR_SITE_URL>", # Optional. Site URL for rankings on openrouter.ai.
+    "X-Title": "<YOUR_SITE_NAME>", # Optional. Site title for rankings on openrouter.ai.
+  },
+  model="openai/gpt-4o",
+  messages=[
+    {
+      "role": "user",
+      "content": "What is the meaning of life?"
+    }
+  ]
+)
+
+print(completion.choices[0].message.content)
+```
+
+```typescript title="TypeScript"
+import OpenAI from 'openai';
+
+const openai = new OpenAI({
+  baseURL: 'https://openrouter.ai/api/v1',
+  apiKey: '<OPENROUTER_API_KEY>',
+  defaultHeaders: {
+    'HTTP-Referer': '<YOUR_SITE_URL>', // Optional. Site URL for rankings on openrouter.ai.
+    'X-Title': '<YOUR_SITE_NAME>', // Optional. Site title for rankings on openrouter.ai.
+  },
+});
+
+async function main() {
+  const completion = await openai.chat.completions.create({
+    model: 'openai/gpt-4o',
+    messages: [
+      {
+        role: 'user',
+        content: 'What is the meaning of life?',
+      },
+    ],
+  });
+
+  console.log(completion.choices[0].message);
+}
+
+main();
+```
+
+</CodeGroup>
+
+## Using the OpenRouter API directly
+
+<Tip>
+  You can use the interactive [Request Builder](/request-builder) to generate OpenRouter API requests in the language of your choice.
+</Tip>
+
+<CodeGroup>
+
+```python title="Python"
+import requests
+import json
+
+response = requests.post(
+  url="https://openrouter.ai/api/v1/chat/completions",
+  headers={
+    "Authorization": "Bearer <OPENROUTER_API_KEY>",
+    "HTTP-Referer": "<YOUR_SITE_URL>", # Optional. Site URL for rankings on openrouter.ai.
+    "X-Title": "<YOUR_SITE_NAME>", # Optional. Site title for rankings on openrouter.ai.
+  },
+  data=json.dumps({
+    "model": "openai/gpt-4o", # Optional
+    "messages": [
+      {
+        "role": "user",
+        "content": "What is the meaning of life?"
+      }
+    ]
+  })
+)
+```
+
+```typescript title="TypeScript"
+fetch('https://openrouter.ai/api/v1/chat/completions', {
+  method: 'POST',
+  headers: {
+    Authorization: 'Bearer <OPENROUTER_API_KEY>',
+    'HTTP-Referer': '<YOUR_SITE_URL>', // Optional. Site URL for rankings on openrouter.ai.
+    'X-Title': '<YOUR_SITE_NAME>', // Optional. Site title for rankings on openrouter.ai.
+    'Content-Type': 'application/json',
+  },
+  body: JSON.stringify({
+    model: 'openai/gpt-4o',
+    messages: [
+      {
+        role: 'user',
+        content: 'What is the meaning of life?',
+      },
+    ],
+  }),
+});
+```
+
+```shell title="Shell"
+curl https://openrouter.ai/api/v1/chat/completions \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer $OPENROUTER_API_KEY" \
+  -d '{
+  "model": "openai/gpt-4o",
+  "messages": [
+    {
+      "role": "user",
+      "content": "What is the meaning of life?"
+    }
+  ]
+}'
+```
+
+</CodeGroup>
+
+The API also supports [streaming](/docs/api-reference/streaming).
+
+## Using third-party SDKs
+
+For information about using third-party SDKs and frameworks with OpenRouter, please [see our frameworks documentation.](/docs/community/frameworks-overview)
+---
+title: Model Routing
+subtitle: Dynamically route requests to models
+headline: Model Routing | Dynamic AI Model Selection and Fallback
+canonical-url: 'https://openrouter.ai/docs/features/model-routing'
+'og:site_name': OpenRouter Documentation
+'og:title': Model Routing - Smart Model Selection and Fallback
+'og:description': >-
+  Route requests dynamically between AI models. Learn how to use OpenRouter's
+  Auto Router and model fallback features for optimal performance and
+  reliability.
+'og:image':
+  type: url
+  value: >-
+    https://openrouter.ai/dynamic-og?title=Model%20Routing&description=Dynamic%20AI%20model%20selection%20and%20fallbacks
+'og:image:width': 1200
+'og:image:height': 630
+'twitter:card': summary_large_image
+'twitter:site': '@OpenRouterAI'
+noindex: false
+nofollow: false
+---
+
+import { API_KEY_REF } from '../../../imports/constants';
+
+OpenRouter provides two options for model routing.
+
+## Auto Router
+
+The [Auto Router](https://openrouter.ai/openrouter/auto), a special model ID that you can use to choose between selected high-quality models based on your prompt, powered by [NotDiamond](https://www.notdiamond.ai/).
+
+```json
+{
+  "model": "openrouter/auto",
+  ... // Other params
+}
+```
+
+The resulting generation will have `model` set to the model that was used.
+
+## The `models` parameter
+
+The `models` parameter lets you automatically try other models if the primary model's providers are down, rate-limited, or refuse to reply due to content moderation.
+
+```json
+{
+  "models": ["anthropic/claude-3.5-sonnet", "gryphe/mythomax-l2-13b"],
+  ... // Other params
+}
+```
+
+If the model you selected returns an error, OpenRouter will try to use the fallback model instead. If the fallback model is down or returns an error, OpenRouter will return that error.
+
+By default, any error can trigger the use of a fallback model, including context length validation errors, moderation flags for filtered models, rate-limiting, and downtime.
+
+Requests are priced using the model that was ultimately used, which will be returned in the `model` attribute of the response body.
+
+## Using with OpenAI SDK
+
+To use the `models` array with the OpenAI SDK, include it in the `extra_body` parameter. In the example below, gpt-4o will be tried first, and the `models` array will be tried in order as fallbacks.
+
+<Template data={{
+  API_KEY_REF,
+}}>
+<CodeGroup>
+
+```typescript
+import OpenAI from 'openai';
+
+const openrouterClient = new OpenAI({
+  baseURL: 'https://openrouter.ai/api/v1',
+  // API key and headers
+});
+
+async function main() {
+  // @ts-expect-error
+  const completion = await openrouterClient.chat.completions.create({
+    model: 'openai/gpt-4o',
+    models: ['anthropic/claude-3.5-sonnet', 'gryphe/mythomax-l2-13b'],
+    messages: [
+      {
+        role: 'user',
+        content: 'What is the meaning of life?',
+      },
+    ],
+  });
+  console.log(completion.choices[0].message);
+}
+
+main();
+```
+
+```python
+from openai import OpenAI
+
+openai_client = OpenAI(
+  base_url="https://openrouter.ai/api/v1",
+  api_key={{API_KEY_REF}},
+)
+
+completion = openai_client.chat.completions.create(
+    model="openai/gpt-4o",
+    extra_body={
+        "models": ["anthropic/claude-3.5-sonnet", "gryphe/mythomax-l2-13b"],
+    },
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the meaning of life?"
+        }
+    ]
+)
+
+print(completion.choices[0].message.content)
+```
+
+</CodeGroup>
+</Template>
+---
+title: Provider Routing
+subtitle: Route requests to the best provider
+headline: Provider Routing | Intelligent Multi-Provider Request Routing
+canonical-url: 'https://openrouter.ai/docs/features/provider-routing'
+'og:site_name': OpenRouter Documentation
+'og:title': Provider Routing - Smart Multi-Provider Request Management
+'og:description': >-
+  Route AI model requests across multiple providers intelligently. Learn how to
+  optimize for cost, performance, and reliability with OpenRouter's provider
+  routing.
+'og:image':
+  type: url
+  value: >-
+    https://openrouter.ai/dynamic-og?pathname=features/provider-routing&title=Smart%20Routing&description=Optimize%20AI%20requests%20across%20providers%20for%20best%20performance
+'og:image:width': 1200
+'og:image:height': 630
+'twitter:card': summary_large_image
+'twitter:site': '@OpenRouterAI'
+noindex: false
+nofollow: false
+---
+import { ProviderPreferencesSchema } from '../../../imports/constants';
+import { TSFetchCodeBlock } from '../../../imports/TSFetchCodeBlock';
+import { ZodToJSONSchemaBlock } from '../../../imports/ZodToJSONSchemaBlock';
+import { TermsOfServiceDescriptions } from '../../../imports/TermsOfServiceDescriptions';
+
+OpenRouter routes requests to the best available providers for your model. By default, [requests are load balanced](#price-based-load-balancing-default-strategy) across the top providers to maximize uptime.
+
+You can customize how your requests are routed using the `provider` object in the request body for [Chat Completions](/docs/api-reference/chat-completion) and [Completions](/docs/api-reference/completion).
+
+<Tip>
+  For a complete list of valid provider names to use in the API, see the [full
+  provider schema](#json-schema-for-provider-preferences).
+</Tip>
+
+The `provider` object can contain the following fields:
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `order` | string[] | - | List of provider slugs to try in order (e.g. `["anthropic", "openai"]`). [Learn more](#ordering-specific-providers) |
+| `allow_fallbacks` | boolean | `true` | Whether to allow backup providers when the primary is unavailable. [Learn more](#disabling-fallbacks) |
+| `require_parameters` | boolean | `false` | Only use providers that support all parameters in your request. [Learn more](#requiring-providers-to-support-all-parameters-beta) |
+| `data_collection` | "allow" \| "deny" | "allow" | Control whether to use providers that may store data. [Learn more](#requiring-providers-to-comply-with-data-policies) |
+| `only` | string[] | - | List of provider slugs to allow for this request. [Learn more](#allowing-only-specific-providers) |
+| `ignore` | string[] | - | List of provider slugs to skip for this request. [Learn more](#ignoring-providers) |
+| `quantizations` | string[] | - | List of quantization levels to filter by (e.g. `["int4", "int8"]`). [Learn more](#quantization) |
+| `sort` | string | - | Sort providers by price or throughput. (e.g. `"price"` or `"throughput"`). [Learn more](#provider-sorting) |
+| `max_price` | object | - | The maximum pricing you want to pay for this request. [Learn more](#maximum-price) |
+
+## Price-Based Load Balancing (Default Strategy)
+
+For each model in your request, OpenRouter's default behavior is to load balance requests across providers, prioritizing price.
+
+If you are more sensitive to throughput than price, you can use the `sort` field to explicitly prioritize throughput.
+
+<Tip>
+  When you send a request with `tools` or `tool_choice`, OpenRouter will only
+  route to providers that support tool use. Similarly, if you set a
+  `max_tokens`, then OpenRouter will only route to providers that support a
+  response of that length.
+</Tip>
+
+Here is OpenRouter's default load balancing strategy:
+
+1. Prioritize providers that have not seen significant outages in the last 30 seconds.
+2. For the stable providers, look at the lowest-cost candidates and select one weighted by inverse square of the price (example below).
+3. Use the remaining providers as fallbacks.
+
+<Note title="A Load Balancing Example">
+If Provider A costs \$1 per million tokens, Provider B costs \$2, and Provider C costs \$3, and Provider B recently saw a few outages.
+
+- Your request is routed to Provider A. Provider A is 9x more likely to be first routed to Provider A than Provider C because $(1 / 3^2 = 1/9)$ (inverse square of the price).
+- If Provider A fails, then Provider C will be tried next.
+- If Provider C also fails, Provider B will be tried last.
+
+</Note>
+
+If you have `sort` or `order` set in your provider preferences, load balancing will be disabled.
+
+## Provider Sorting
+
+As described above, OpenRouter load balances based on price, while taking uptime into account.
+
+If you instead want to _explicitly_ prioritize a particular provider attribute, you can include the `sort` field in the `provider` preferences. Load balancing will be disabled, and the router will try providers in order.
+
+The three sort options are:
+
+- `"price"`: prioritize lowest price
+- `"throughput"`: prioritize highest throughput
+- `"latency"`: prioritize lowest latency
+
+<TSFetchCodeBlock
+  title='Example with Fallbacks Enabled'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-70b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      sort: 'throughput',
+    },
+  }}
+/>
+
+To _always_ prioritize low prices, and not apply any load balancing, set `sort` to `"price"`.
+
+To _always_ prioritize low latency, and not apply any load balancing, set `sort` to `"latency"`.
+
+## Nitro Shortcut
+
+You can append `:nitro` to any model slug as a shortcut to sort by throughput. This is exactly equivalent to setting `provider.sort` to `"throughput"`.
+
+<TSFetchCodeBlock
+  title='Example using Nitro shortcut'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-70b-instruct:nitro',
+    messages: [{ role: 'user', content: 'Hello' }],
+  }}
+/>
+
+## Floor Price Shortcut
+
+You can append `:floor` to any model slug as a shortcut to sort by price. This is exactly equivalent to setting `provider.sort` to `"price"`.
+
+<TSFetchCodeBlock
+  title='Example using Floor shortcut'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-70b-instruct:floor',
+    messages: [{ role: 'user', content: 'Hello' }],
+  }}
+/>
+
+## Ordering Specific Providers
+
+You can set the providers that OpenRouter will prioritize for your request using the `order` field.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `order` | string[] | - | List of provider slugs to try in order (e.g. `["anthropic", "openai"]`). |
+
+The router will prioritize providers in this list, and in this order, for the model you're using. If you don't set this field, the router will [load balance](#price-based-load-balancing-default-strategy) across the top providers to maximize uptime.
+
+<Tip>
+  You can use the copy button next to provider names on model pages to get the exact provider slug, 
+  including any variants like "/turbo". See [Targeting Specific Provider Endpoints](#targeting-specific-provider-endpoints) for details.
+</Tip>
+
+OpenRouter will try them one at a time and proceed to other providers if none are operational. If you don't want to allow any other providers, you should [disable fallbacks](#disabling-fallbacks) as well.
+
+### Example: Specifying providers with fallbacks
+
+This example skips over OpenAI (which doesn't host Mixtral), tries Together, and then falls back to the normal list of providers on OpenRouter:
+
+<TSFetchCodeBlock
+  title='Example with Fallbacks Enabled'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'mistralai/mixtral-8x7b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      order: ['openai', 'together'],
+    },
+  }}
+/>
+
+### Example: Specifying providers with fallbacks disabled
+
+Here's an example with `allow_fallbacks` set to `false` that skips over OpenAI (which doesn't host Mixtral), tries Together, and then fails if Together fails:
+
+<TSFetchCodeBlock
+  title='Example with Fallbacks Disabled'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'mistralai/mixtral-8x7b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      order: ['openai', 'together'],
+      allow_fallbacks: false,
+    },
+  }}
+/>
+
+## Targeting Specific Provider Endpoints
+
+Each provider on OpenRouter may host multiple endpoints for the same model, such as a default endpoint and a specialized "turbo" endpoint. To target a specific endpoint, you can use the copy button next to the provider name on the model detail page to obtain the exact provider slug.
+
+For example, DeepInfra offers DeepSeek R1 through multiple endpoints:
+- Default endpoint with slug `deepinfra`
+- Turbo endpoint with slug `deepinfra/turbo`
+
+By copying the exact provider slug and using it in your request's `order` array, you can ensure your request is routed to the specific endpoint you want:
+
+<TSFetchCodeBlock
+  title='Example targeting DeepInfra Turbo endpoint'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'deepseek/deepseek-r1',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      order: ['deepinfra/turbo'],
+      allow_fallbacks: false,
+    },
+  }}
+/>
+
+This approach is especially useful when you want to consistently use a specific variant of a model from a particular provider.
+
+## Requiring Providers to Support All Parameters
+
+You can restrict requests only to providers that support all parameters in your request using the `require_parameters` field.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `require_parameters` | boolean | `false` | Only use providers that support all parameters in your request. |
+
+With the default routing strategy, providers that don't support all the [LLM parameters](/docs/api-reference/parameters) specified in your request can still receive the request, but will ignore unknown parameters. When you set `require_parameters` to `true`, the request won't even be routed to that provider.
+
+### Example: Excluding providers that don't support JSON formatting
+
+For example, to only use providers that support JSON formatting:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      require_parameters: true,
+    },
+    response_format: { type: 'json_object' },
+  }}
+/>
+
+## Requiring Providers to Comply with Data Policies
+
+You can restrict requests only to providers that comply with your data policies using the `data_collection` field.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `data_collection` | "allow" \| "deny" | "allow" | Control whether to use providers that may store data. |
+
+- `allow`: (default) allow providers which store user data non-transiently and may train on it
+- `deny`: use only providers which do not collect user data
+
+Some model providers may log prompts, so we display them with a **Data Policy** tag on model pages. This is not a definitive source of third party data policies, but represents our best knowledge.
+
+<Tip title='Account-Wide Data Policy Filtering'>
+  This is also available as an account-wide setting in [your privacy
+  settings](https://openrouter.ai/settings/privacy). You can disable third party
+  model providers that store inputs for training.
+</Tip>
+
+### Example: Excluding providers that don't comply with data policies
+
+To exclude providers that don't comply with your data policies, set `data_collection` to `deny`:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      data_collection: 'deny', // or "allow"
+    },
+  }}
+/>
+
+## Disabling Fallbacks
+
+To guarantee that your request is only served by the top (lowest-cost) provider, you can disable fallbacks.
+
+This is combined with the `order` field from [Ordering Specific Providers](#ordering-specific-providers) to restrict the providers that OpenRouter will prioritize to just your chosen list.
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      allow_fallbacks: false,
+    },
+  }}
+/>
+
+## Allowing Only Specific Providers
+
+You can allow only specific providers for a request by setting the `only` field in the `provider` object.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `only` | string[] | - | List of provider slugs to allow for this request. |
+
+<Warning>
+    Only allowing some providers may significantly reduce fallback options and
+    limit request recovery.
+</Warning>
+
+<Tip title="Account-Wide Allowed Providers">
+    You can allow providers for all account requests by configuring your [preferences](/settings/preferences). This configuration applies to all API requests and chatroom messages.
+
+    Note that when you allow providers for a specific request, the list of allowed providers is merged with your account-wide allowed providers.
+
+</Tip>
+
+
+### Example: Allowing Azure for a request calling GPT-4 Omni
+
+Here's an example that will only use Azure for a request calling GPT-4 Omni:
+
+<TSFetchCodeBlock
+    uriPath='/api/v1/chat/completions'
+    body={{
+        model: 'openai/gpt-4o',
+        messages: [{ role: 'user', content: 'Hello' }],
+        provider: {
+            only: ['azure'],
+        },
+    }}
+/>
+
+## Ignoring Providers
+
+You can ignore providers for a request by setting the `ignore` field in the `provider` object.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `ignore` | string[] | - | List of provider slugs to skip for this request. |
+
+<Warning>
+  Ignoring multiple providers may significantly reduce fallback options and
+  limit request recovery.
+</Warning>
+
+<Tip title="Account-Wide Ignored Providers">
+You can ignore providers for all account requests by configuring your [preferences](/settings/preferences). This configuration applies to all API requests and chatroom messages.
+
+Note that when you ignore providers for a specific request, the list of ignored providers is merged with your account-wide ignored providers.
+
+</Tip>
+
+### Example: Ignoring DeepInfra for a request calling Llama 3.3 70b
+
+Here's an example that will ignore DeepInfra for a request calling Llama 3.3 70b:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.3-70b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      ignore: ['deepinfra'],
+    },
+  }}
+/>
+
+## Quantization
+
+Quantization reduces model size and computational requirements while aiming to preserve performance. Most LLMs today use FP16 or BF16 for training and inference, cutting memory requirements in half compared to FP32. Some optimizations use FP8 or quantization to reduce size further (e.g., INT8, INT4).
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `quantizations` | string[] | - | List of quantization levels to filter by (e.g. `["int4", "int8"]`). [Learn more](#quantization) |
+
+<Warning>
+  Quantized models may exhibit degraded performance for certain prompts,
+  depending on the method used.
+</Warning>
+
+Providers can support various quantization levels for open-weight models.
+
+### Quantization Levels
+
+By default, requests are load-balanced across all available providers, ordered by price. To filter providers by quantization level, specify the `quantizations` field in the `provider` parameter with the following values:
+
+- `int4`: Integer (4 bit)
+- `int8`: Integer (8 bit)
+- `fp4`: Floating point (4 bit)
+- `fp6`: Floating point (6 bit)
+- `fp8`: Floating point (8 bit)
+- `fp16`: Floating point (16 bit)
+- `bf16`: Brain floating point (16 bit)
+- `fp32`: Floating point (32 bit)
+- `unknown`: Unknown
+
+### Example: Requesting FP8 Quantization
+
+Here's an example that will only use providers that support FP8 quantization:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-8b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      quantizations: ['fp8'],
+    },
+  }}
+/>
+
+### Max Price
+
+To filter providers by price, specify the `max_price` field in the `provider` parameter with a JSON object specifying the highest provider pricing you will accept.
+
+For example, the value `{"prompt": 1, "completion": 2}` will route to any provider with a price of `<= $1/m` prompt tokens, and `<= $2/m` completion tokens or less.
+
+Some providers support per request pricing, in which case you can use the `request` attribute of max_price. Lastly, `image` is also available, which specifies the max price per image you will accept.
+
+Practically, this field is often combined with a provider `sort` to express, for example, "Use the provider with the highest throughput, as long as it doesn\'t cost more than `$x/m` tokens."
+
+
+## Terms of Service
+
+You can view the terms of service for each provider below. You may not violate the terms of service or policies of third-party providers that power the models on OpenRouter.
+
+<TermsOfServiceDescriptions />
+
+## JSON Schema for Provider Preferences
+
+For a complete list of options, see this JSON schema:
+
+<ZodToJSONSchemaBlock
+  title='Provider Preferences Schema'
+  schema={ProviderPreferencesSchema}
+/>
+ 2-we will use openrouter not claude api 3- you should use api.recoder.xyz and engine.recoder.xyz also you most likely will need to use openrouter api import OpenAI from 'openai';
+
+const openai = new OpenAI({
+  baseURL: 'https://openrouter.ai/api/v1',
+  apiKey: '<OPENROUTER_API_KEY>',
+  defaultHeaders: {
+    'HTTP-Referer': '<YOUR_SITE_URL>', // Optional. Site URL for rankings on openrouter.ai.
+    'X-Title': '<YOUR_SITE_NAME>', // Optional. Site title for rankings on openrouter.ai.
+  },
+});
+
+async function main() {
+  const completion = await openai.chat.completions.create({
+    model: 'openai/gpt-4o',
+    messages: [
+      {
+        role: 'user',
+        content: 'What is the meaning of life?',
+      },
+    ],
+  });
+
+  console.log(completion.choices[0].message);
+}
+
+main();
+---
+title: Model Routing
+subtitle: Dynamically route requests to models
+headline: Model Routing | Dynamic AI Model Selection and Fallback
+canonical-url: 'https://openrouter.ai/docs/features/model-routing'
+'og:site_name': OpenRouter Documentation
+'og:title': Model Routing - Smart Model Selection and Fallback
+'og:description': >-
+  Route requests dynamically between AI models. Learn how to use OpenRouter's
+  Auto Router and model fallback features for optimal performance and
+  reliability.
+'og:image':
+  type: url
+  value: >-
+    https://openrouter.ai/dynamic-og?title=Model%20Routing&description=Dynamic%20AI%20model%20selection%20and%20fallbacks
+'og:image:width': 1200
+'og:image:height': 630
+'twitter:card': summary_large_image
+'twitter:site': '@OpenRouterAI'
+noindex: false
+nofollow: false
+---
+
+import { API_KEY_REF } from '../../../imports/constants';
+
+OpenRouter provides two options for model routing.
+
+## Auto Router
+
+The [Auto Router](https://openrouter.ai/openrouter/auto), a special model ID that you can use to choose between selected high-quality models based on your prompt, powered by [NotDiamond](https://www.notdiamond.ai/).
+
+```json
+{
+  "model": "openrouter/auto",
+  ... // Other params
+}
+```
+
+The resulting generation will have `model` set to the model that was used.
+
+## The `models` parameter
+
+The `models` parameter lets you automatically try other models if the primary model's providers are down, rate-limited, or refuse to reply due to content moderation.
+
+```json
+{
+  "models": ["anthropic/claude-3.5-sonnet", "gryphe/mythomax-l2-13b"],
+  ... // Other params
+}
+```
+
+If the model you selected returns an error, OpenRouter will try to use the fallback model instead. If the fallback model is down or returns an error, OpenRouter will return that error.
+
+By default, any error can trigger the use of a fallback model, including context length validation errors, moderation flags for filtered models, rate-limiting, and downtime.
+
+Requests are priced using the model that was ultimately used, which will be returned in the `model` attribute of the response body.
+
+## Using with OpenAI SDK
+
+To use the `models` array with the OpenAI SDK, include it in the `extra_body` parameter. In the example below, gpt-4o will be tried first, and the `models` array will be tried in order as fallbacks.
+
+<Template data={{
+  API_KEY_REF,
+}}>
+<CodeGroup>
+
+```typescript
+import OpenAI from 'openai';
+
+const openrouterClient = new OpenAI({
+  baseURL: 'https://openrouter.ai/api/v1',
+  // API key and headers
+});
+
+async function main() {
+  // @ts-expect-error
+  const completion = await openrouterClient.chat.completions.create({
+    model: 'openai/gpt-4o',
+    models: ['anthropic/claude-3.5-sonnet', 'gryphe/mythomax-l2-13b'],
+    messages: [
+      {
+        role: 'user',
+        content: 'What is the meaning of life?',
+      },
+    ],
+  });
+  console.log(completion.choices[0].message);
+}
+
+main();
+```
+
+```python
+from openai import OpenAI
+
+openai_client = OpenAI(
+  base_url="https://openrouter.ai/api/v1",
+  api_key={{API_KEY_REF}},
+)
+
+completion = openai_client.chat.completions.create(
+    model="openai/gpt-4o",
+    extra_body={
+        "models": ["anthropic/claude-3.5-sonnet", "gryphe/mythomax-l2-13b"],
+    },
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the meaning of life?"
+        }
+    ]
+)
+
+print(completion.choices[0].message.content)
+```
+
+</CodeGroup>
+</Template>
+---
+title: Provider Routing
+subtitle: Route requests to the best provider
+headline: Provider Routing | Intelligent Multi-Provider Request Routing
+canonical-url: 'https://openrouter.ai/docs/features/provider-routing'
+'og:site_name': OpenRouter Documentation
+'og:title': Provider Routing - Smart Multi-Provider Request Management
+'og:description': >-
+  Route AI model requests across multiple providers intelligently. Learn how to
+  optimize for cost, performance, and reliability with OpenRouter's provider
+  routing.
+'og:image':
+  type: url
+  value: >-
+    https://openrouter.ai/dynamic-og?pathname=features/provider-routing&title=Smart%20Routing&description=Optimize%20AI%20requests%20across%20providers%20for%20best%20performance
+'og:image:width': 1200
+'og:image:height': 630
+'twitter:card': summary_large_image
+'twitter:site': '@OpenRouterAI'
+noindex: false
+nofollow: false
+---
+import { ProviderPreferencesSchema } from '../../../imports/constants';
+import { TSFetchCodeBlock } from '../../../imports/TSFetchCodeBlock';
+import { ZodToJSONSchemaBlock } from '../../../imports/ZodToJSONSchemaBlock';
+import { TermsOfServiceDescriptions } from '../../../imports/TermsOfServiceDescriptions';
+
+OpenRouter routes requests to the best available providers for your model. By default, [requests are load balanced](#price-based-load-balancing-default-strategy) across the top providers to maximize uptime.
+
+You can customize how your requests are routed using the `provider` object in the request body for [Chat Completions](/docs/api-reference/chat-completion) and [Completions](/docs/api-reference/completion).
+
+<Tip>
+  For a complete list of valid provider names to use in the API, see the [full
+  provider schema](#json-schema-for-provider-preferences).
+</Tip>
+
+The `provider` object can contain the following fields:
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `order` | string[] | - | List of provider slugs to try in order (e.g. `["anthropic", "openai"]`). [Learn more](#ordering-specific-providers) |
+| `allow_fallbacks` | boolean | `true` | Whether to allow backup providers when the primary is unavailable. [Learn more](#disabling-fallbacks) |
+| `require_parameters` | boolean | `false` | Only use providers that support all parameters in your request. [Learn more](#requiring-providers-to-support-all-parameters-beta) |
+| `data_collection` | "allow" \| "deny" | "allow" | Control whether to use providers that may store data. [Learn more](#requiring-providers-to-comply-with-data-policies) |
+| `only` | string[] | - | List of provider slugs to allow for this request. [Learn more](#allowing-only-specific-providers) |
+| `ignore` | string[] | - | List of provider slugs to skip for this request. [Learn more](#ignoring-providers) |
+| `quantizations` | string[] | - | List of quantization levels to filter by (e.g. `["int4", "int8"]`). [Learn more](#quantization) |
+| `sort` | string | - | Sort providers by price or throughput. (e.g. `"price"` or `"throughput"`). [Learn more](#provider-sorting) |
+| `max_price` | object | - | The maximum pricing you want to pay for this request. [Learn more](#maximum-price) |
+
+## Price-Based Load Balancing (Default Strategy)
+
+For each model in your request, OpenRouter's default behavior is to load balance requests across providers, prioritizing price.
+
+If you are more sensitive to throughput than price, you can use the `sort` field to explicitly prioritize throughput.
+
+<Tip>
+  When you send a request with `tools` or `tool_choice`, OpenRouter will only
+  route to providers that support tool use. Similarly, if you set a
+  `max_tokens`, then OpenRouter will only route to providers that support a
+  response of that length.
+</Tip>
+
+Here is OpenRouter's default load balancing strategy:
+
+1. Prioritize providers that have not seen significant outages in the last 30 seconds.
+2. For the stable providers, look at the lowest-cost candidates and select one weighted by inverse square of the price (example below).
+3. Use the remaining providers as fallbacks.
+
+<Note title="A Load Balancing Example">
+If Provider A costs \$1 per million tokens, Provider B costs \$2, and Provider C costs \$3, and Provider B recently saw a few outages.
+
+- Your request is routed to Provider A. Provider A is 9x more likely to be first routed to Provider A than Provider C because $(1 / 3^2 = 1/9)$ (inverse square of the price).
+- If Provider A fails, then Provider C will be tried next.
+- If Provider C also fails, Provider B will be tried last.
+
+</Note>
+
+If you have `sort` or `order` set in your provider preferences, load balancing will be disabled.
+
+## Provider Sorting
+
+As described above, OpenRouter load balances based on price, while taking uptime into account.
+
+If you instead want to _explicitly_ prioritize a particular provider attribute, you can include the `sort` field in the `provider` preferences. Load balancing will be disabled, and the router will try providers in order.
+
+The three sort options are:
+
+- `"price"`: prioritize lowest price
+- `"throughput"`: prioritize highest throughput
+- `"latency"`: prioritize lowest latency
+
+<TSFetchCodeBlock
+  title='Example with Fallbacks Enabled'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-70b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      sort: 'throughput',
+    },
+  }}
+/>
+
+To _always_ prioritize low prices, and not apply any load balancing, set `sort` to `"price"`.
+
+To _always_ prioritize low latency, and not apply any load balancing, set `sort` to `"latency"`.
+
+## Nitro Shortcut
+
+You can append `:nitro` to any model slug as a shortcut to sort by throughput. This is exactly equivalent to setting `provider.sort` to `"throughput"`.
+
+<TSFetchCodeBlock
+  title='Example using Nitro shortcut'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-70b-instruct:nitro',
+    messages: [{ role: 'user', content: 'Hello' }],
+  }}
+/>
+
+## Floor Price Shortcut
+
+You can append `:floor` to any model slug as a shortcut to sort by price. This is exactly equivalent to setting `provider.sort` to `"price"`.
+
+<TSFetchCodeBlock
+  title='Example using Floor shortcut'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-70b-instruct:floor',
+    messages: [{ role: 'user', content: 'Hello' }],
+  }}
+/>
+
+## Ordering Specific Providers
+
+You can set the providers that OpenRouter will prioritize for your request using the `order` field.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `order` | string[] | - | List of provider slugs to try in order (e.g. `["anthropic", "openai"]`). |
+
+The router will prioritize providers in this list, and in this order, for the model you're using. If you don't set this field, the router will [load balance](#price-based-load-balancing-default-strategy) across the top providers to maximize uptime.
+
+<Tip>
+  You can use the copy button next to provider names on model pages to get the exact provider slug, 
+  including any variants like "/turbo". See [Targeting Specific Provider Endpoints](#targeting-specific-provider-endpoints) for details.
+</Tip>
+
+OpenRouter will try them one at a time and proceed to other providers if none are operational. If you don't want to allow any other providers, you should [disable fallbacks](#disabling-fallbacks) as well.
+
+### Example: Specifying providers with fallbacks
+
+This example skips over OpenAI (which doesn't host Mixtral), tries Together, and then falls back to the normal list of providers on OpenRouter:
+
+<TSFetchCodeBlock
+  title='Example with Fallbacks Enabled'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'mistralai/mixtral-8x7b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      order: ['openai', 'together'],
+    },
+  }}
+/>
+
+### Example: Specifying providers with fallbacks disabled
+
+Here's an example with `allow_fallbacks` set to `false` that skips over OpenAI (which doesn't host Mixtral), tries Together, and then fails if Together fails:
+
+<TSFetchCodeBlock
+  title='Example with Fallbacks Disabled'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'mistralai/mixtral-8x7b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      order: ['openai', 'together'],
+      allow_fallbacks: false,
+    },
+  }}
+/>
+
+## Targeting Specific Provider Endpoints
+
+Each provider on OpenRouter may host multiple endpoints for the same model, such as a default endpoint and a specialized "turbo" endpoint. To target a specific endpoint, you can use the copy button next to the provider name on the model detail page to obtain the exact provider slug.
+
+For example, DeepInfra offers DeepSeek R1 through multiple endpoints:
+- Default endpoint with slug `deepinfra`
+- Turbo endpoint with slug `deepinfra/turbo`
+
+By copying the exact provider slug and using it in your request's `order` array, you can ensure your request is routed to the specific endpoint you want:
+
+<TSFetchCodeBlock
+  title='Example targeting DeepInfra Turbo endpoint'
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'deepseek/deepseek-r1',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      order: ['deepinfra/turbo'],
+      allow_fallbacks: false,
+    },
+  }}
+/>
+
+This approach is especially useful when you want to consistently use a specific variant of a model from a particular provider.
+
+## Requiring Providers to Support All Parameters
+
+You can restrict requests only to providers that support all parameters in your request using the `require_parameters` field.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `require_parameters` | boolean | `false` | Only use providers that support all parameters in your request. |
+
+With the default routing strategy, providers that don't support all the [LLM parameters](/docs/api-reference/parameters) specified in your request can still receive the request, but will ignore unknown parameters. When you set `require_parameters` to `true`, the request won't even be routed to that provider.
+
+### Example: Excluding providers that don't support JSON formatting
+
+For example, to only use providers that support JSON formatting:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      require_parameters: true,
+    },
+    response_format: { type: 'json_object' },
+  }}
+/>
+
+## Requiring Providers to Comply with Data Policies
+
+You can restrict requests only to providers that comply with your data policies using the `data_collection` field.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `data_collection` | "allow" \| "deny" | "allow" | Control whether to use providers that may store data. |
+
+- `allow`: (default) allow providers which store user data non-transiently and may train on it
+- `deny`: use only providers which do not collect user data
+
+Some model providers may log prompts, so we display them with a **Data Policy** tag on model pages. This is not a definitive source of third party data policies, but represents our best knowledge.
+
+<Tip title='Account-Wide Data Policy Filtering'>
+  This is also available as an account-wide setting in [your privacy
+  settings](https://openrouter.ai/settings/privacy). You can disable third party
+  model providers that store inputs for training.
+</Tip>
+
+### Example: Excluding providers that don't comply with data policies
+
+To exclude providers that don't comply with your data policies, set `data_collection` to `deny`:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      data_collection: 'deny', // or "allow"
+    },
+  }}
+/>
+
+## Disabling Fallbacks
+
+To guarantee that your request is only served by the top (lowest-cost) provider, you can disable fallbacks.
+
+This is combined with the `order` field from [Ordering Specific Providers](#ordering-specific-providers) to restrict the providers that OpenRouter will prioritize to just your chosen list.
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      allow_fallbacks: false,
+    },
+  }}
+/>
+
+## Allowing Only Specific Providers
+
+You can allow only specific providers for a request by setting the `only` field in the `provider` object.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `only` | string[] | - | List of provider slugs to allow for this request. |
+
+<Warning>
+    Only allowing some providers may significantly reduce fallback options and
+    limit request recovery.
+</Warning>
+
+<Tip title="Account-Wide Allowed Providers">
+    You can allow providers for all account requests by configuring your [preferences](/settings/preferences). This configuration applies to all API requests and chatroom messages.
+
+    Note that when you allow providers for a specific request, the list of allowed providers is merged with your account-wide allowed providers.
+
+</Tip>
+
+
+### Example: Allowing Azure for a request calling GPT-4 Omni
+
+Here's an example that will only use Azure for a request calling GPT-4 Omni:
+
+<TSFetchCodeBlock
+    uriPath='/api/v1/chat/completions'
+    body={{
+        model: 'openai/gpt-4o',
+        messages: [{ role: 'user', content: 'Hello' }],
+        provider: {
+            only: ['azure'],
+        },
+    }}
+/>
+
+## Ignoring Providers
+
+You can ignore providers for a request by setting the `ignore` field in the `provider` object.
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `ignore` | string[] | - | List of provider slugs to skip for this request. |
+
+<Warning>
+  Ignoring multiple providers may significantly reduce fallback options and
+  limit request recovery.
+</Warning>
+
+<Tip title="Account-Wide Ignored Providers">
+You can ignore providers for all account requests by configuring your [preferences](/settings/preferences). This configuration applies to all API requests and chatroom messages.
+
+Note that when you ignore providers for a specific request, the list of ignored providers is merged with your account-wide ignored providers.
+
+</Tip>
+
+### Example: Ignoring DeepInfra for a request calling Llama 3.3 70b
+
+Here's an example that will ignore DeepInfra for a request calling Llama 3.3 70b:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.3-70b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      ignore: ['deepinfra'],
+    },
+  }}
+/>
+
+## Quantization
+
+Quantization reduces model size and computational requirements while aiming to preserve performance. Most LLMs today use FP16 or BF16 for training and inference, cutting memory requirements in half compared to FP32. Some optimizations use FP8 or quantization to reduce size further (e.g., INT8, INT4).
+
+| Field | Type | Default | Description |
+| --- | --- | --- | --- |
+| `quantizations` | string[] | - | List of quantization levels to filter by (e.g. `["int4", "int8"]`). [Learn more](#quantization) |
+
+<Warning>
+  Quantized models may exhibit degraded performance for certain prompts,
+  depending on the method used.
+</Warning>
+
+Providers can support various quantization levels for open-weight models.
+
+### Quantization Levels
+
+By default, requests are load-balanced across all available providers, ordered by price. To filter providers by quantization level, specify the `quantizations` field in the `provider` parameter with the following values:
+
+- `int4`: Integer (4 bit)
+- `int8`: Integer (8 bit)
+- `fp4`: Floating point (4 bit)
+- `fp6`: Floating point (6 bit)
+- `fp8`: Floating point (8 bit)
+- `fp16`: Floating point (16 bit)
+- `bf16`: Brain floating point (16 bit)
+- `fp32`: Floating point (32 bit)
+- `unknown`: Unknown
+
+### Example: Requesting FP8 Quantization
+
+Here's an example that will only use providers that support FP8 quantization:
+
+<TSFetchCodeBlock
+  uriPath='/api/v1/chat/completions'
+  body={{
+    model: 'meta-llama/llama-3.1-8b-instruct',
+    messages: [{ role: 'user', content: 'Hello' }],
+    provider: {
+      quantizations: ['fp8'],
+    },
+  }}
+/>
+
+### Max Price
+
+To filter providers by price, specify the `max_price` field in the `provider` parameter with a JSON object specifying the highest provider pricing you will accept.
+
+For example, the value `{"prompt": 1, "completion": 2}` will route to any provider with a price of `<= $1/m` prompt tokens, and `<= $2/m` completion tokens or less.
+
+Some providers support per request pricing, in which case you can use the `request` attribute of max_price. Lastly, `image` is also available, which specifies the max price per image you will accept.
+
+Practically, this field is often combined with a provider `sort` to express, for example, "Use the provider with the highest throughput, as long as it doesn\'t cost more than `$x/m` tokens."
+
+
+## Terms of Service
+
+You can view the terms of service for each provider below. You may not violate the terms of service or policies of third-party providers that power the models on OpenRouter.
+
+<TermsOfServiceDescriptions />
+
+## JSON Schema for Provider Preferences
+
+For a complete list of options, see this JSON schema:
+
+<ZodToJSONSchemaBlock
+  title='Provider Preferences Schema'
+  schema={ProviderPreferencesSchema}
+/>