Documentation de Make Agent Fast

État des SDK

Choisissez l'API REST stable ou évaluez les clients en préversion disponibles uniquement en code source, sans présumer de leur disponibilité sur un registre.

En un coup d’œil

Choisissez l'API REST stable ou évaluez les clients en préversion disponibles uniquement en code source, sans présumer de leur disponibilité sur un registre.

Parcours des requêtes APIClé à portée limitée → ressource versionnée → réponse signée

REST disponibleOpenAPISDK en préversion

L'API REST versionnée est aujourd'hui la seule surface d'intégration publique prise en charge. Le code source des clients JavaScript, Python et des clients pour frameworks existe dans le dépôt du produit, mais les paquets ne sont actuellement publiés ni sur npm ni sur PyPI.

Disponibilité#

Client	Statut	Comment l'utiliser
REST sur HTTPS	Disponible	Appelez `https://makeagent.fast/api/v1` depuis n'importe quel client HTTP côté serveur
Document OpenAPI	Disponible	Téléchargez /api/openapi.json et examinez-le avant de générer un client
`@make-agent-fast/sdk`	Préversion en code source — absent de npm	N'ajoutez pas cet import à un projet de production tant qu'une version publiée sur un registre n'est pas indiquée ici
Paquet Python `makeagentfast`	Préversion en code source — absent de PyPI	Utilisez `requests`, `httpx` ou la bibliothèque standard de Python tant qu'une version PyPI n'est pas indiquée ici
Adaptateurs React, Vue, Svelte	Préversion en code source — absents de npm	Privilégiez le modèle de chargement par script documenté pour votre framework
Composant web	Préversion en code source — absent de npm	Privilégiez le chargeur standard `embed.js`

JavaScript sans SDK#

const response = await fetch("https://makeagent.fast/api/v1/sites?limit=100", {
  headers: {
    Authorization: `Bearer ${process.env.MAF_API_KEY}`,
    Accept: "application/json",
  },
});

const body = await response.json();
if (!response.ok) {
  console.error(body.error.code, body.error.request_id);
  throw new Error(`Make Agent Fast request failed (${response.status})`);
}

for (const site of body.data) console.log(site.id, site.title);

Conservez la clé API côté serveur. Un bundle navigateur React, Vue ou Svelte doit appeler votre propre backend ou installer le chargeur d'intégration public ; il ne doit pas appeler l'API de gestion avec un secret.

Python sans SDK#

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://makeagent.fast/api/v1/sites?limit=100",
    headers={
        "Authorization": f"Bearer {os.environ['MAF_API_KEY']}",
        "Accept": "application/json",
    },
)

with urllib.request.urlopen(request, timeout=20) as response:
    payload = json.load(response)

for site in payload["data"]:
    print(site["id"], site["title"])

En production, interceptez urllib.error.HTTPError et analysez son corps JSON à l'aide de l'enveloppe d'erreur stable.

Clients générés#

La génération à partir d'OpenAPI n'est utile que si le document contient les opérations et les schémas dont dépend votre application. Figez la spécification téléchargée, générez le code dans un répertoire facile à relire et examinez chaque différence avant toute mise à niveau.

curl --fail-with-body https://makeagent.fast/api/openapi.json \
  --output make-agent-fast.openapi.json

Ne régénérez pas et ne déployez pas automatiquement un client à partir de l'URL en ligne. L'ajout d'un nouveau champ ne devrait pas casser un client, mais le comportement du générateur et les noms des méthodes générées peuvent tout de même changer.

Ce que doit inclure une version publique d'un SDK#

Avant qu'un client en préversion soit déclaré disponible, il doit proposer :

Une page publique sur un registre et une version sémantique immuable.
Des instructions d'installation, de mise à niveau et des environnements d'exécution pris en charge.
Des modèles typés de requêtes et de réponses générés à partir du contrat d'API complet.
Des erreurs structurées qui conservent le statut HTTP et l'identifiant de requête.
Des utilitaires de pagination qui traitent les curseurs comme opaques.
Une prise en charge explicite des clés d'idempotence pour les mutations.
Des tests CI par rapport au contrat /api/v1 actuel et un journal des modifications publié.

Tant que ces conditions ne sont pas remplies, utilisez les exemples REST du démarrage rapide de l'API et des recettes d'API.