Quick Start

https://api.yolorouter.com/v1

http://localhost:8080/v1

Listens on port 8080 by default; swap in your own instance address.

Every example below uses the YoloRouter Cloud endpoint. If you self-host, substitute the address from the self-hosted tab.

Create an API key

Create the key in the console of whichever deployment you picked above — a key only authenticates the gateway that issued it.

YoloRouter Cloud — sign in at https://yolorouter.com/dashboard
Self-hosted — open your own instance, http://localhost:8080 by default

Go to API Keys and click Create API Key. Copy the key — it's shown only once.

export YOLO_ROUTER_API_KEY="sk-..."

Self-hosted only: add a provider and a model

Skip this step on YoloRouter Cloud — its model catalogue is ready to use.

A freshly installed instance has no providers and no models, so any request fails until you configure one. In your console: Providers → add a provider and paste its upstream key, then Models → create a public model name and map it to that provider's model id.

That public name is what you pass as model below — substitute it for the deepseek-v4-pro used in these examples.

Point your SDK to Yolo Router

Replace the OpenAI base URL with Yolo Router's endpoint. Your existing API key and code stay the same — only the base URL and the auth key change.

from openai import OpenAI

client = OpenAI(
    api_key="sk-...",        # your Yolo Router key
    base_url="https://api.yolorouter.com/v1",
)

import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: 'sk-...',          // your Yolo Router key
  baseURL: 'https://api.yolorouter.com/v1',
})

export YOLO_ROUTER_API_KEY="sk-..."

Make your first request

response = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[{"role": "user", "content": "Hello!"}],
)
print(response.choices[0].message.content)

const response = await client.chat.completions.create({
  model: 'deepseek-v4-pro',
  messages: [{ role: 'user', content: 'Hello!' }],
})
console.log(response.choices[0].message.content)

curl https://api.yolorouter.com/v1/chat/completions \
  -H "Authorization: Bearer $YOLO_ROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-v4-pro",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

List available models

curl https://api.yolorouter.com/v1/models \
  -H "Authorization: Bearer $YOLO_ROUTER_API_KEY"

Create an API key

Self-hosted only: add a provider and a model

Point your SDK to Yolo Router

Make your first request

List available models

On this page