EasyRouterEasyRouter
Quick StartAPI DocsConnect Agent Tools

Quick Start

Get up and running with EasyRouter in 5 minutes — get your API Key, make your first AI call, and connect your tools.

EasyRouter is a unified AI model gateway, fully compatible with the OpenAI API format. With a single API Key and Base URL, you can access dozens of leading AI models — GPT, Claude, Gemini, Kimi, and more — without managing separate accounts or credentials for each provider.

Whether you call the API directly from code or use client tools like Claude Code or OpenClaw, the setup is always the same.

Part 1 — Get Up and Running in 5 Minutes

Step 1 — Get Your API Key

1.1 Log In to the EasyRouter Console

Open https://easyrouter.io and sign in to your account.

Log in to EasyRouter console

1.2 Go to Token Manager and Create a Token

Click Token Manager in the left sidebar, then click Create Token in the top-right corner.

Token Manager — Create Token

Enter a token name (e.g. my-first-key), set a quota and expiry date if needed, then confirm.

Create Token dialog

1.3 Copy Your Base URL and API Key

Once the token is created, you'll see the following in the token list:

  • Base URL: https://easyrouter.io — use this as the endpoint for all API calls
  • API Key: starts with sk- — shown only once, copy and store it immediately

Copy Base URL and API Key from the token list

Important

Your API Key is only shown once at creation. If you lose it, you will need to create a new token.


Step 2 — Make Your First API Call

EasyRouter is fully compatible with the OpenAI API. Any SDK or tool that supports OpenAI only needs the base_url and api_key swapped to EasyRouter's values.

2.1 Quick Test with curl

curl https://easyrouter.io/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "user", "content": "Hello! Introduce yourself."}
    ]
  }'

2.2 Python (openai SDK)

from openai import OpenAI

client = OpenAI(
    base_url="https://easyrouter.io/v1",
    api_key="sk-YOUR_API_KEY"
)

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

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

2.3 List Available Models

Not sure which model names to use? Query /v1/models to get the full list:

curl https://easyrouter.io/v1/models \
  -H "Authorization: Bearer sk-YOUR_API_KEY"

The id field in each returned object is the model name to use in your API calls.


Step 3 — Connect Your Tools

EasyRouter works with any OpenAI-compatible client or tool. You need three things:

ParameterValue
API Address (Base URL)https://easyrouter.io
API KeyThe token you created in the console
Model NameFrom /v1/models, or the console model list

Claude Code / Codex CLI

Command-line code assistants.

When using Claude Code or Codex CLI in your terminal, set the following environment variables:

# Claude Code
export ANTHROPIC_BASE_URL="https://easyrouter.io"
export ANTHROPIC_API_KEY="sk-YOUR_API_KEY"

# Codex CLI
export OPENAI_BASE_URL="https://easyrouter.io/v1"
export OPENAI_API_KEY="sk-YOUR_API_KEY"

Full guide: Claude Code · Codex CLI

OpenClaw

Self-hosted AI assistant platform, recommended for advanced users.

OpenClaw is a self-hosted AI assistant platform with multi-channel support (Telegram, Discord, Feishu, and more). Add EasyRouter as a model provider in ~/.openclaw/openclaw.json:

{
  "models": {
    "mode": "merge",
    "providers": {
      "easyrouter": {
        "baseUrl": "https://easyrouter.io/v1",
        "apiKey": "sk-YOUR_API_KEY",
        "api": "openai-completions",
        "models": [
          { "id": "gpt-4o", "name": "GPT-4o" },
          { "id": "claude-3-5-sonnet", "name": "Claude 3.5 Sonnet" }
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "easyrouter/gpt-4o"
      }
    }
  }
}

Full guide: OpenClaw

Cherry Studio

Desktop AI client, recommended for beginners.

Cherry Studio is a feature-rich desktop AI chat client that supports multi-model conversations.

  1. Download and install Cherry Studio: https://cherry-ai.com/download
  2. Open SettingsModel ProvidersAdd Provider
  3. Set provider type to OpenAI (or OpenAI-compatible)
  4. API Address: https://easyrouter.io
  5. API Key: your EasyRouter token
  6. Add the model IDs you want to use (query /v1/models for the full list)

One-click Auto-fill

The EasyRouter console Token Manager supports one-click auto-fill for Cherry Studio. Click the button on the token list page and Cherry Studio will be configured automatically.

Full guide: Cherry Studio

Any Other OpenAI-Compatible Tool

For any tool that allows a custom API endpoint, just configure:

  • API Address / Base URLhttps://easyrouter.io
  • API Key → your EasyRouter token
  • Model Name → from /v1/models

Browse all verified app integration guides: Connect Agent Tools


Part 2 — API Capabilities Overview

EasyRouter exposes the following AI model APIs, all in OpenAI-compatible format:

APIEndpointDescription
Chat CompletionsPOST /v1/chat/completionsMulti-turn conversations, streaming (stream: true), Tool Calling, structured outputs
Text CompletionsPOST /v1/completionsClassic single-turn text completion
Image GenerationPOST /v1/images/generationsAI image generation
Video GenerationPOST /v1/videosAI video generation
Model ListGET /v1/modelsQuery all currently available models

Full API reference: API Docs


Part 3 — FAQ