Démarrage rapide API

Ce guide vous aide à connecter une application à YouRouter, à envoyer une requête de test et à vérifier la structure de la réponse. YouRouter expose des points de terminaison compatibles OpenAI sur https://api.yourouter.ai/v1 : la plupart des intégrations SDK OpenAI existantes ne nécessitent qu’un changement d’URL de base et de clé API.

Besoin d’une clé API ? Créez-en une dans le tableau de bord YouRouter.

Informations de base

Élément	Valeur
URL de base	`https://api.yourouter.ai/v1`
En-tête d’authentification	`Authorization: Bearer <YOUR_YOUROUTER_API_KEY>`
Type de contenu	`Content-Type: application/json`
Champ modèle	Envoyez l’ID du modèle cible dans `model`
Entrée multimodale	Envoyez du texte et des blocs image dans `messages[].content`
Routage par défaut	Omettez `vendor`, ou envoyez `vendor: auto`
Routage fixé	Envoyez `vendor: openai`, `vendor: anthropic`, `vendor: google`, ou un autre fournisseur pris en charge

1. Configurer votre clé API

Stockez votre clé API dans une variable d’environnement avant d’exécuter les exemples ci-dessous.

macOS/Linux
Windows
.env

export YOUROUTER_API_KEY="your-api-key-here"

set YOUROUTER_API_KEY=your-api-key-here

YOUROUTER_API_KEY=your-api-key-here

N’exposez jamais votre clé API dans du code côté navigateur, des applications mobiles, des dépôts publics ou les journaux clients.

2. Envoyer une requête de test

Le moyen le plus rapide de valider l’intégration est une requête HTTP directe vers le point de terminaison Chat Completions. Une réponse réussie contient choices[0].message.content.

cURL
Python requests
Node.js fetch

curl https://api.yourouter.ai/v1/chat/completions \
  -H "Authorization: Bearer $YOUROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "user",
        "content": "Reply with exactly: connected"
      }
    ]
  }'

import os
import requests

response = requests.post(
    "https://api.yourouter.ai/v1/chat/completions",
    headers={
        "Authorization": f"Bearer {os.environ['YOUROUTER_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "model": "gpt-4o",
        "messages": [
            {
                "role": "user",
                "content": "Reply with exactly: connected",
            }
        ],
    },
)

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

const response = await fetch('https://api.yourouter.ai/v1/chat/completions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.YOUROUTER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model: 'gpt-4o',
    messages: [
      {
        role: 'user',
        content: 'Reply with exactly: connected',
      },
    ],
  }),
});

const data = await response.json();
console.log(data.choices[0].message.content);

3. Migrer du code SDK OpenAI existant

Si votre application utilise déjà le SDK OpenAI, conservez la forme du corps de requête et mettez à jour deux champs : api_key et base_url.

Python
Node.js

pip install openai

import os
from openai import OpenAI

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

completion = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {
            "role": "user",
            "content": "Reply with exactly: connected",
        }
    ],
)

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

npm install openai

import OpenAI from 'openai';

const openai = new OpenAI({
  apiKey: process.env.YOUROUTER_API_KEY,
  baseURL: 'https://api.yourouter.ai/v1',
});

const completion = await openai.chat.completions.create({
  model: 'gpt-4o',
  messages: [
    {
      role: 'user',
      content: 'Reply with exactly: connected',
    },
  ],
});

console.log(completion.choices[0].message.content);

4. Choisir un modèle et un routage

Choisissez un modèle via le champ model. Vous pouvez appeler de nombreuses familles de modèles avec la même forme d’API : modèles GPT OpenAI, Claude, Gemini, DeepSeek, Grok, Doubao, Kimi, etc. Pour la vision et les autres entrées multimodales, voir le guide Multimodal. Par défaut, YouRouter utilise le routage automatique. Omettez l’en-tête vendor, ou définissez vendor: auto, pour laisser YouRouter choisir le meilleur fournisseur disponible pour le modèle demandé. Ne fixez un fournisseur que lorsque votre intégration dépend d’un comportement amont précis, d’une variante de modèle, d’un compte ou d’un parcours de conformité.

cURL
Python SDK
Node.js SDK

curl https://api.yourouter.ai/v1/chat/completions \
  -H "Authorization: Bearer $YOUROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -H "vendor: openai" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello from a pinned provider."}]
  }'

completion = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello from a pinned provider."}],
    extra_headers={"vendor": "openai"},
)

const completion = await openai.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Hello from a pinned provider.' }],
}, {
  headers: { vendor: 'openai' },
});

Voir Modèles pour des exemples d’API modèle et le guide Routage pour les identifiants de fournisseur, le basculement automatique et les recommandations de production.

5. Gérer les réponses et les erreurs

Pour les points de terminaison compatibles OpenAI, les réponses réussies suivent le format OpenAI. Lisez le texte généré dans choices[0].message.content.

{
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "connected"
      }
    }
  ]
}

Codes d’état courants pour l’intégration :

Statut	Signification	Action d’intégration
`200`	Requête réussie	Analyser le corps de la réponse
`401`	Clé API manquante ou invalide	Vérifier l’en-tête `Authorization`
`429`	Limite de débit amont	Réessayer avec backoff ou ajuster le routage
`500`	Erreur fournisseur ou passerelle	Réessayer prudemment et journaliser l’ID de requête

6. Réponses en flux (streaming)

Pour les interfaces de chat et les agents, définissez stream sur true pour recevoir des fragments incrémentaux pendant la génération du texte.

stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Explain automatic routing in two sentences."}],
    stream=True,
)

for chunk in stream:
    delta = chunk.choices[0].delta.content
    if delta:
        print(delta, end="")

Voir Créer une complétion de chat pour la forme complète de la requête.

Étapes suivantes

Référence API

Consultez les points de terminaison, les paramètres et les formats de réponse.

Modèles

Voyez comment passer les ID de modèle et changer de modèle via l’API.

Multimodal

Envoyez des images et appelez les API multimodales natives des fournisseurs.

Guide routage

Apprenez quand utiliser le routage automatique ou fixer un fournisseur.

Complétions de chat

Construisez des conversations, du streaming, des outils et des flux multimodaux.

Premiers pas

API modèles

Routage et fiabilité

Référence API

Fonctionnalités

Juridique

Informations de base

1. Configurer votre clé API

2. Envoyer une requête de test

3. Migrer du code SDK OpenAI existant

4. Choisir un modèle et un routage

5. Gérer les réponses et les erreurs

6. Réponses en flux (streaming)

Étapes suivantes

Référence API

Modèles

Multimodal

Guide routage

Complétions de chat

Premiers pas

API modèles

Routage et fiabilité

Référence API

Fonctionnalités

Juridique

​Informations de base

​1. Configurer votre clé API

​2. Envoyer une requête de test

​3. Migrer du code SDK OpenAI existant

​4. Choisir un modèle et un routage

​5. Gérer les réponses et les erreurs

​6. Réponses en flux (streaming)

​Étapes suivantes

Référence API

Modèles

Multimodal

Guide routage

Complétions de chat

Informations de base

1. Configurer votre clé API

2. Envoyer une requête de test

3. Migrer du code SDK OpenAI existant

4. Choisir un modèle et un routage

5. Gérer les réponses et les erreurs

6. Réponses en flux (streaming)

Étapes suivantes