Clés API & API HIVE

Pilotez HIVE par programmation

Au-delà du dashboard, HIVE expose une API REST. Avec une clé API, vous déclenchez un agent depuis un script, Zapier, un cron ou votre propre application — et vous récupérez ses résultats automatiquement.

Une clé
Générée depuis vos paramètres
Un appel
Déclenchez un agent en HTTP
Un résultat
Récupéré en retour ou par webhook

1. À quoi sert une clé API ?

Une clé API permet à un système externe d'agir en votre nom sur HIVE, sans passer par l'interface. Typiquement :

  • Déclencher un agent quand un évènement arrive dans votre outil (formulaire, CRM, e-commerce)
  • Lancer une tâche depuis un script ou un cron maison
  • Connecter HIVE à Zapier / Make ou à votre propre application
  • Déployer, mettre en pause ou suivre vos agents de façon automatisée

À ne pas confondre : il ne s'agit pas d'une clé d'un fournisseur d'IA. Vous n'avez aucune clé Anthropic à fournir — HIVE s'en charge, et l'usage est décompté de vos crédits. La clé API HIVE sert à appeler HIVE, pas l'inverse.

2. Créer une clé

  1. Allez dans Paramètres > Développeur
  2. Donnez un nom à la clé (ex. « Intégration Zapier », « Script interne ») pour la reconnaître plus tard
  3. Créez-la, puis copiez-la immédiatement
La clé n'est affichée qu'une seule fois

HIVE n'en stocke qu'une empreinte chiffrée (hash) — impossible de la ré-afficher ensuite. Si vous la perdez, révoquez-la et créez-en une nouvelle. Une clé ressemble à hive_…, et seuls ses premiers caractères restent visibles dans la liste.

3. Authentifier vos appels

Passez votre clé dans l'en-tête Authorization, en Bearer. Exemple : déclencher une tâche sur un agent.

Soumettre une tâche
curl -X POST https://votre-app/api/agents/AGENT_ID/tasks \
  -H "Authorization: Bearer hive_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{ "input": "Résume les nouveaux leads de la semaine" }'
Résultat asynchrone

Une tâche s'exécute en tâche de fond. Vous pouvez interroger son statut (endpoint de détail de tâche) ou fournir un callbackUrl dans le corps de la requête : HIVE y enverra le résultat dès que la tâche est terminée.

4. Ce que l'API permet

AgentsLister, déployer, modifier, mettre en pause / réactiver, supprimer
TâchesSoumettre une tâche, lister, consulter le détail, annuler
PlanificationsLister et créer les exécutions programmées d'un agent

La référence complète (tous les endpoints, leurs paramètres et leurs réponses) est publiée au format OpenAPI : /api/docs/openapi.json. Vous pouvez l'importer dans Postman, Insomnia ou un générateur de client.

5. Sécurité & bonnes pratiques

Une clé = un mot de passe

Une clé donne accès à l'API de votre compte. Ne la mettez jamais dans du code public ni côté navigateur — gardez-la dans une variable d'environnement côté serveur.

  • Expiration : une clé peut être créée avec une durée de vie limitée.
  • Révocation : supprimez une clé à tout moment depuis l'onglet Développeur — elle cesse aussitôt de fonctionner.
  • Restriction d'IP : une clé peut être limitée à des adresses ou plages d'IP autorisées (les requêtes hors liste sont refusées).
  • Une clé par usage : créez-en une distincte par intégration, pour pouvoir en révoquer une sans casser les autres.

Les appels par clé API consomment vos crédits et comptent dans les limites de votre plan, exactement comme une tâche lancée à la main. L'adresse e-mail du compte doit être vérifiée pour exécuter des tâches.

Générez votre première clé

Créez une clé dans vos paramètres et déclenchez un agent en un appel HTTP.

Ouvrir Paramètres > Développeur