Documentation de l'API
Tout ce que fait cette page passe par l'API ci-dessous. Tes outils peuvent l'appeler de la même façon.
Adresse et authentification
Adresse de base :
Chaque appel à /v1/… doit porter ta clé API dans l'en-tête Authorization: Bearer <clé>. Sans clé valide, la réponse est 401 et rien ne s'exécute. La clé se crée avec le script scripts/new-api-key.ps1 du projet ; elle n'est affichée qu'une fois.
Envoyer un message
Le corps accepte : prompt (obligatoire), cwd (dossier de travail), new (repartir d'une conversation vide), provider et model.
La réponse est un flux : une ligne JSON par événement. Avec l'en-tête Accept: text/event-stream, le même flux arrive au format SSE.
| Événement | Contenu |
|---|---|
session | identifiant de la conversation et modèle |
text | un bloc de texte de la réponse |
tool_use | un outil appelé par le modèle, avec son entrée |
permission | la décision du serveur sur un outil : allowed et reason |
result | fin du tour : subtype, is_error, coût et jetons |
error | le tour a échoué en cours de route |
Les autres appels
| Méthode | Chemin | Rôle |
|---|---|---|
| GET | /health | état du service, sans authentification |
| GET | /v1/providers | noms des profils de modèle |
| GET | /v1/sessions | liste des sessions |
| POST | /v1/sessions/{nom}/prompt | un tour de conversation |
| POST | /v1/sessions/{nom}/interrupt | arrête le tour en cours |
| DELETE | /v1/sessions/{nom}?forget=true|false | arrête le process ; forget=true oublie la conversation |
Le client en ligne de commande
Codes de réponse
400 | requête invalide (nom, dossier, modèle, JSON) |
401 | clé absente ou incorrecte |
409 | un tour est déjà en cours sur cette session |
413 | message trop long |
429 | trop de requêtes ou trop de sessions actives |
502 | Claude Code n'a pas pu démarrer ou s'est arrêté |