Quickstart

Send your first chat completion through routeur.ai in three steps. The request shape is OpenAI-compatible, so any client that talks to api.openai.com can talk to api.routeur.ai with a base URL change and a different bearer token.

1. Get an API key

Sign in to the routeur.ai dashboard, open Settings → API keys, and click Create key. Copy the value once — routeur.ai stores only the hash. Set it in your shell:

shell

export ROUTEUR_KEY="rtr_your_routeur_api_key"

2. Send a chat completion

Pick a tab. Each example uses auto as the model alias, which lets routing rules pick the upstream model for you.

curl https://api.routeur.ai/v1/chat/completions \
  -H "Authorization: Bearer $ROUTEUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "auto",
    "messages": [{"role": "user", "content": "Say hello."}]
  }'

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.ROUTEUR_KEY,
  baseURL: "https://api.routeur.ai/v1",
});

const r = await client.chat.completions.create({
  model: "auto",
  messages: [{ role: "user", content: "Say hello." }],
});

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["ROUTEUR_KEY"],
    base_url="https://api.routeur.ai/v1",
)

r = client.chat.completions.create(
    model="auto",
    messages=[{"role": "user", "content": "Say hello."}],
)

<?php
require 'vendor/autoload.php';

$client = OpenAI::factory()
    ->withApiKey(getenv('ROUTEUR_KEY'))
    ->withBaseUri('https://api.routeur.ai/v1')
    ->make();

$response = $client->chat()->create([
    'model' => 'auto',
    'messages' => [
        ['role' => 'user', 'content' => 'Say hello.'],
    ],
]);

require "openai"

client = OpenAI::Client.new(
  access_token: ENV.fetch("ROUTEUR_KEY"),
  uri_base: "https://api.routeur.ai/v1",
)

response = client.chat(
  parameters: {
    model: "auto",
    messages: [{ role: "user", content: "Say hello." }],
  },
)

client := openai.NewClient(
    option.WithAPIKey(os.Getenv("ROUTEUR_KEY")),
    option.WithBaseURL("https://api.routeur.ai/v1"),
)

resp, err := client.Chat.Completions.New(ctx, openai.ChatCompletionNewParams{
    Model: openai.F("auto"),
    Messages: openai.F([]openai.ChatCompletionMessageParamUnion{
        openai.UserMessage("Say hello."),
    }),
})

using OpenAI;
using OpenAI.Chat;

var client = new ChatClient(
    model: "auto",
    credential: new ApiKeyCredential(Environment.GetEnvironmentVariable("ROUTEUR_KEY")!),
    options: new OpenAIClientOptions { Endpoint = new Uri("https://api.routeur.ai/v1") });

ChatCompletion completion = client.CompleteChat("Say hello.");

OpenAIClient client = OpenAIOkHttpClient.builder()
    .apiKey(System.getenv("ROUTEUR_KEY"))
    .baseUrl("https://api.routeur.ai/v1")
    .build();

ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
    .model("auto")
    .addUserMessage("Say hello.")
    .build();

ChatCompletion completion = client.chat().completions().create(params);

3. Inspect the route

Add Routeur-Trace: true to any request to receive a routeur block in the response describing which upstream was picked, how many redactions ran, and how much it cost.

200application/json

Response excerpt

{
  "choices": [{ "message": { "content": "Hello!" } }],
  "routeur": {
    "provider": "openai",
    "model": "gpt-4o-mini",
    "route_reason": "default",
    "latency_ms": 2939,
    "cost_usd": 0.00000615
  }
}

Try a dry run. Add Routeur-Dry-Run: true to see the route routeur.ai would have picked without calling the upstream provider or spending tokens.

← Introduction

Authentication →