Aller au contenu

Présentation de l'API de la plateforme

L’API de la plateforme permet à des scripts et à des systèmes tiers de gérer votre compte RouteAPI en votre nom : consulter le solde, créer et gérer les clés API, et consulter les logs du compte (avec export CSV/JSONL) ainsi que les statistiques d’usage.

Base URL : https://www.routeapi.ai/api/open/v1
Authentification : Authorization: Bearer rat_xxxx — voir Authentification de l’API de la plateforme pour créer et conserver une clé de gestion.

Fenêtre de terminal
curl https://www.routeapi.ai/api/open/v1/balance \
-H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

Tous les endpoints sous /api/open/v1 utilisent le même en-tête. Les réponses utilisent le corps unifié { success, message, data } ; voir Erreurs et limites pour ce format, les codes d’erreur et les limites de débit.

Les champs de montant sont exprimés dans la devise d’affichage du site, avec deux décimales (par exemple 10.00) ; la devise est retournée par Obtenir le solde. Chaque montant est arrondi séparément ; un montant total peut donc différer de jusqu’à 0,01 de la somme des montants ligne par ligne.

Les endpoints de liste utilisent la même pagination par page :

ParamètreTypeDéfautDescription
pinteger1Numéro de page, de 1 à 1000000
page_sizeinteger10Éléments par page, de 1 à 1000

Un p ou page_size fourni explicitement doit rester dans ces plages. Les valeurs non entières, 0, négatives ou hors plage retournent 400 invalid_request ; elles ne sont jamais remplacées ni plafonnées silencieusement. Les champs page / page_size de la réponse sont les valeurs réellement appliquées.

Pour les endpoints de logs, total est compté jusqu’à 10000 et vaut toujours 10000 au-delà ; récupérez les données plus anciennes par fenêtres temporelles plus courtes.

N’insérez pas de ; brut dans la query string ; encodez-le en %3B, sinon la requête entière retourne 400 invalid_request. Encodez % en %25 et utilisez + ou %20 pour les espaces.

Les chemins ci-dessous sont relatifs à https://www.routeapi.ai/api/open/v1.

MéthodeCheminDescription
GET/balanceObtenir le solde
MéthodeCheminDescription
GET/keysLister les API Keys
GET/keys/:idObtenir une API Key
GET/keys/:id/keyRévéler une API Key
POST/keysCréer une API Key
PATCH/keys/:idMettre à jour une API Key
DELETE/keys/:idSupprimer une API Key
MéthodeCheminDescription
GET/logsObtenir les logs du compte
GET/logs/exportExporter les logs
MéthodeCheminDescription
GET/usageObtenir les statistiques d’usage
GET/usage/modelsObtenir l’usage par modèle
GET/usage/keysObtenir l’usage par Key