Quick Start

AutoRouter is a unified AI model gateway compatible with the OpenAI API format. With a single Base URL and API Key, you can call GPT, Claude, Gemini, Kimi, and other mainstream models through one interface—without managing separate accounts for each provider.

Part 1 — Get Started

Follow the steps below in order to register, create an API key, and verify connectivity. Each step includes screenshots and completion checkpoints.

How to Use This Guide

1. Complete Steps 1 → 6 in order—do not skip ahead.
2. Compare your results with the expected outcome and completion checkpoint for each step.
3. Screenshots show the real console UI—follow the highlighted areas.
4. You only need these three values throughout:

Step 1 — Open the Website

1.1 Open the Homepage

Expected result — The page loads normally; Sign in is visible in the header.

Step 2 — Register and Sign In

2.1 Register (if you don't have an account)

Expected result — Success message, or redirect to sign-in / dashboard.

2.2 Sign In (existing account)

2.3 Open the Dashboard

✅ Step 2 complete — Signed in; sidebar shows API Keys, Playground, etc.

Step 3 — Create an API Key

API keys authenticate all client and code requests.

3.1 Open API Keys

Expected result — Page title is API Keys; Create API Key button in the top-right.

3.2 Create a Key

3.3 Fill the Form

3.4 Copy and Save

⚠️ Important: Keys are often shown only once. Do not share publicly; revoke and recreate if leaked.

✅ Step 3 complete — API URL and API Key saved securely.

Step 4 — Verify Connectivity

Use Playground in the console to send a test message.

Expected result — You receive a text reply from the model.

✅ Step 4 complete — Playground returns an AI response.

Step 5 — Get a Model Name

✅ Step 5 complete — At least one model name recorded.

Step 6 (Optional) — Connect Cherry Studio

This section uses Cherry Studio as an example. Any OpenAI-compatible client works with the same API URL, key, and model name.

6.1 Install the Client

1. Download from Cherry Studio and install.

6.2 Add a Provider

6.3 Enter Connection Details

6.4 Add Model from Library

Expected result — gpt-5.4 appears in the model list.

6.5 Add Model Manually (if not found)

6.6 Test Chat

After saving, go to Home, select the model, send Hello, and expect a reply.

✅ Step 6 complete — Cherry Studio (or another client) chats successfully.

Part 2 — Developer Integration

After the quick start above, use these examples to integrate via SDK or CLI. The platform is OpenAI-compatible—replace base_url and api_key with your values.

2.1 Prerequisites

2.2 Verify with curl

curl https://autorouter.top/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-yourAPIKey" \
  -d '{
    "model": "gpt-5.4",
    "messages": [
      {"role": "user", "content": "Hello, introduce yourself"}
    ]
  }'

2.3 Python SDK

from openai import OpenAI

client = OpenAI(
    base_url="https://autorouter.top/v1",
    api_key="sk-yourAPIKey",
)

response = client.chat.completions.create(
    model="gpt-5.4",
    messages=[
        {"role": "user", "content": "Hello, introduce yourself"},
    ],
)

print(response.choices[0].message.content)

2.4 List Available Models

curl https://autorouter.top/v1/models \
  -H "Authorization: Bearer sk-yourAPIKey"

The id field in the response is the model parameter for API calls.

Part 3 — Connect Your Tools

Any OpenAI-compatible client needs only these three values:

3.1 Three Essentials

3.2 Claude Code / Codex CLI

For CLI coding assistants, set:

export OPENAI_API_KEY="sk-yourAPIKey"
export OPENAI_BASE_URL="https://autorouter.top/v1"

3.3 OpenClaw

Add to ~/.openclaw/openclaw.json:

{
  "models": {
    "mode": "merge",
    "providers": {
      "autorouter": {
        "baseUrl": "https://autorouter.top/v1",
        "apiKey": "sk-yourAPIKey",
        "api": "openai-completions",
        "models": [
          { "id": "gpt-5.4", "name": "GPT-5.4" }
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "autorouter/gpt-5.4"
      }
    }
  }
}

3.4 Other OpenAI-Compatible Tools

• API URL / Base URL → https://autorouter.top
• API Key → Your console key
• Model name → From /v1/models

More verified app guides: Agent Tools.

Part 4 — API Overview

Full reference: API Docs.

Part 5 — Troubleshooting

Part 6 — More Help