Skip to main content
L’API Bookivox est une API server-to-server. Toutes les requêtes passent par le préfixe /api/v1/api et s’authentifient avec une clé API.
Les clés API doivent rester côté serveur. Ne les embarquez jamais dans du code client (navigateur, application mobile) ni dans un dépôt public.

Authentification

Ajoutez votre clé dans l’en-tête X-API-Key.
L’en-tête Authorization est interdit sur cette surface : sa présence renvoie 400. Utilisez uniquement X-API-Key.

Créer une clé API

  1. Ouvrez Workspace → Clés API dans le dashboard.
  2. Créez une clé avec un nom parlant (ex. « Backend production »).
  3. Copiez la valeur immédiatement : elle n’est affichée qu’une seule fois.
Une clé donne accès à toute l’organisation. Pour cloisonner, créez une clé par environnement de votre application.

Surfaces disponibles

Appels HTTP classiques décrits dans cette référence. Idéal pour automatiser la création d’agents, lancer des campagnes ou interroger votre base de connaissance depuis votre backend.
  • Base URL : https://api.bookivox.com/api/v1/api
  • Auth : en-tête X-API-Key

Webhooks

Deux directions existent, à ne pas confondre.
Le nœud Webhook d’un agent envoie une requête HTTP vers une URL de votre choix pendant ou après l’appel. Vous recevez les données de l’appel (transcription, résumé, variables collectées) et pouvez déclencher vos propres traitements.

Nœud Webhook

Champs, variables de template, cas d’usage et sécurité.
Vous exposez un endpoint que l’agent appelle pendant l’appel (vérifier une disponibilité, créer un rendez-vous…). Bookivox appelle votre API avec les paramètres définis.

Outil HTTP API

Configuration complète d’un outil HTTP.
Les endpoints sortants vers votre serveur doivent être idempotents : un même événement peut être livré plusieurs fois. Utilisez un identifiant d’événement pour dédupliquer.

Étapes suivantes

Démarrage rapide

Votre première requête en quelques minutes.

Codes d'erreur

Comprendre et gérer les réponses d’erreur.
Last modified on October 28, 2026