Démarrer gratuitement →

SDK et CLI

Référence de l’API

Chaque route qu’appelle une application, un agent ou un fournisseur d’identité : comment elle s’authentifie, la portée qu’une clé doit avoir, les champs qu’elle prend et les réponses qu’elle donne.

Le fichier OpenAPI

La même référence sous forme de fichier OpenAPI 3.1, pour les générateurs de code et les tests de contrat. Il est construit à partir du contrat que les tests d’Azoth confrontent aux routes dans les deux sens : une route qui y manque, ou une route qu’il nomme et qui n’existe pas, les fait échouer.

openapi.yaml

Les résumés des routes et les noms des champs sont écrits en anglais, ici comme dans le fichier.

Authentification

Authorization
Bearer <key> : une clé API de l’espace de travail, créée dans Réglages › Accès — az_live_…, ou az_test_… sur l’offre gratuite. Une clé à portée limitée n’atteint que les routes que ses portées couvrent.
X-Azoth-API-Key
<key> : la même clé dans son propre en-tête. Chaque route qui prend une clé accepte les deux.

Les lectures propres au tableau de bord — /api/v1/me et les lectures GreenOps — prennent une session connectée, jamais une clé. Les routes SCIM prennent le jeton SCIM de l’espace de travail (provisionnement SCIM).

Réponses et erreurs

Une réponse d’erreur porte error, une phrase, un code stable et un doc_url qui mène à l’entrée du code dans Codes d’erreur ; un 400 nomme aussi le field en cause. Une limite de débit répond 429 avec retryAfterMs dans le corps et Retry-After dans les en-têtes. Une route dont le déploiement ne fait pas tourner le module le dit. Un appel à la passerelle qui n’est pas en streaming (/api/v1/chat/completions, /api/v1/chat) se réessaie sans risque avec un en-tête Idempotency-Key : dans l’heure, un nouvel essai d’un appel qui a reçu sa réponse reçoit cette première réponse — jamais un second appel au modèle, un second scellé ni une seconde dépense — quand la politique de données de l’espace permet à Azoth de la conserver ; sinon le nouvel essai en est averti (idempotency_replay_unavailable), avec la trace du premier appel.

Routes

Une page par partie de l’API, avec chacune de ses routes en entier : son authentification, la portée qu’une clé doit avoir, ses paramètres et les champs de son corps, ses réponses et leurs codes. Ci-dessous, chaque partie avec ses routes, une ligne chacune, liée à son entrée complète. Le fichier donne le type et les limites de chaque champ, et le corps de chaque réponse.

Appels à la passerelle

Appeler un modèle par la passerelle gouvernée — et autour d’un appel : s’il lui faut un modèle, le modèle qu’un premier appel peut utiliser, la reprise d’un appel retenu, une demande d’exception, la vérification d’ancrage et les reçus de votre propre coffre.

Toutes les routes de cette partie, en entier

/api/v1/chat

/api/v1/infer

/api/v1/models

/api/v1/exceptions

/api/v1/grounding

/api/v1/vault

Télémétrie et optimisation

Déclarer les appels faits hors de la passerelle, choisir un modèle pour une requête, chercher et stocker des réponses en cache, vérifier qu’un agent ne boucle pas, compresser un long contenu et interroger la place de marché des fournisseurs.

Toutes les routes de cette partie, en entier

/api/ingest

/api/arbiter

/api/cache

/api/loops

/api/v1/compress

/api/v1/reconstruct

/api/v1/marketplace

Preuve

Lire les décisions scellées, exporter le dossier d’audit ou le dossier d’une décision, récupérer les clés publiques qui vérifient les reçus, et lire les preuves d’Azoth Guard et les incidents de l’espace de travail.

Toutes les routes de cette partie, en entier

/api/v1/journal

/api/v1/decisions

/api/proof

/api/v1/guard

/api/v1/incidents

Systèmes et politiques

Déclarer vos systèmes (cas d’usage) et les lire, avec les appels passés hors de ce pour quoi l’un d’eux a été approuvé ; lire les packs réglementaires et la politique de données que le SDK applique.

Toutes les routes de cette partie, en entier

/api/v1/usecases

/api/v1/policy

/api/v1/governance

Tests et changements de modèle

Gérer les suites de non-régression et les exécuter, ou y comparer des modèles ; lire les exécutions de jeux de référence qui attendent votre système quand un modèle change, et en envoyer les résultats.

Toutes les routes de cette partie, en entier

/api/v1/regression

/api/v1/reference-sets

Agents et MCP

Lire les dépenses et les économies par agent, appeler des outils par la passerelle MCP gouvernée, et exécuter les outils de lecture de l’assistant.

Toutes les routes de cette partie, en entier

/api/v1/agents

/api/v1/mcp

/api/v1/insights

Usage, dépenses et empreinte

Lire les traces d’usage, le rapport des dépenses et des économies, les budgets et leur consommation, et l’empreinte estimée en énergie et en carbone.

Toutes les routes de cette partie, en entier

/api/v1/usage

/api/v1/report

/api/v1/budgets

/api/v1/greenops

Service et compte

Vérifier que le service répond, voir quels modules sont prêts pour la production, exporter les données de l’espace de travail, et lire ou effacer votre propre compte.

Toutes les routes de cette partie, en entier

/api/health

/api/v1/system

/api/v1/export

/api/v1/me

  • GET /api/v1/me — Your personal data (GDPR art. 15) — signed in, never an API key
  • DELETE /api/v1/me — Erase your account (GDPR art. 17) — signed in, never an API key

Provisionnement SCIM

Créer, modifier et retirer des utilisateurs et des groupes depuis votre fournisseur d’identité, avec le jeton SCIM de l’espace de travail.

Toutes les routes de cette partie, en entier

/api/scim/v2