> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bookivox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Concepts

> Le vocabulaire partagé de la surface développeur : agent (workflow), nœud, arête, outil, identifiant, UUID public, run et campagne.

## Le vocabulaire minimal

Ces termes sont utilisés dans toute la documentation. Une bonne compréhension de
ceux-ci évite la plupart des erreurs d'intégration.

> **Agent**
>
> Un agent vocal est un **graphe** appelé `workflow_definition` : une liste de
> **nœuds** reliés par des **arêtes**. Il est stocké côté Bookivox et
> identifiable par un **UUID public**. C'est ce graphe que le moteur exécute
> pendant un appel. Voir [Workflow (JSON)](https://docs.bookivox.com/api-reference/guides/workflow-json).

> **Nœud**
>
> Une étape du graphe. Chaque nœud a un `type` et un `data` dont le schéma
> dépend du type. Les types disponibles :
>
> | `type` | Rôle |
> | - | - |
> | `startCall` | Point d'entrée de l'appel |
> | `agentNode` | Cœur conversationnel (prompt, outils, documents) |
> | `endCall` | Fin d'appel |
> | `globalNode` | Contexte/instructions globales |
> | `trigger` | Déclencheur API |
> | `webhook` | Appel sortant HTTP |
> | `qa` | Analyse qualité |
>
> Le schéma exact des champs de `data` est fourni par le **catalogue**
> `GET /api/v1/api/node-types`. Voir [Nœuds (graphe)](https://docs.bookivox.com/api-reference/nodes).

> **Arête**
>
> Une transition entre deux nœuds. Elle porte un `data.label` (libellé) et un
> `data.condition` (condition de passage). Voir
> [Workflow (JSON)](https://docs.bookivox.com/api-reference/guides/workflow-json).

> **Outil**
>
> Une capacité attachée à un nœud `agentNode` et invoquée **pendant** l'appel.
> Exemples : appeler votre API (`http_api`), raccrocher (`end_call`), transférer
> l'appel (`transfer_call`). Voir [Outils (API)](https://docs.bookivox.com/api-reference/tools).

> **Identifiant (credential)**
>
> Un **secret** (clé API tierce, jeton OAuth) géré côté Bookivox et référencé
> par un `credential_uuid`. Il n'apparaît jamais en clair dans vos définitions.
> Voir [Intégrations HTTP (API)](https://docs.bookivox.com/api-reference/guides/http-api-integrations).

> **UUID public**
>
> La façon dont Bookivox référence les ressources (`workflow`, `tool`,
> `document`, configuration téléphonie) : une chaîne **UUID opaque**, jamais un
> identifiant interne séquentiel. Utilisez toujours la valeur renvoyée par
> l'API.

> **Run**
>
> Une **exécution** d'un agent (un appel). Les runs portent le transcript, le
> résultat d'extraction et les événements. Les campagnes produisent des runs en
> masse.

> **Campagne**
>
> L'exécution d'un agent sur un **ensemble de contacts** (source CSV), avec
> politique de réessai et de planification. Voir
> [Campagnes](https://docs.bookivox.com/api-reference/campaigns).

## Le modèle d'authentification

Une seule méthode pour l'API publique : l'en-tête **`X-API-Key`**.

**Correct**

```http theme={null}
GET /api/v1/api/node-types
X-API-Key: <votre_cle>
```

**Refusé**

```http theme={null}
GET /api/v1/api/node-types
Authorization: Bearer <votre_cle>
```

L'en-tête `Authorization` est **interdit** et renvoie une erreur. Voir
[Démarrage rapide](https://docs.bookivox.com/api-reference/quickstart).

## Suite

> **[Workflow (JSON)](https://docs.bookivox.com/api-reference/guides/workflow-json)**
>
> Le format du graphe en détail.

> **[Nœuds (graphe)](https://docs.bookivox.com/api-reference/nodes)**
>
> Schémas `NodeSpec` / `PropertySpec`.

> **[Outils (API)](https://docs.bookivox.com/api-reference/tools)**
>
> Types d'outils et CRUD.

> **[Erreurs & codes](https://docs.bookivox.com/api-reference/errors)**
>
> Interpréter les réponses.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.