Vue d'ensemble de l'API
Vibedasher expose une API programmatique pour toute la plateforme maintenue — connexions, jeux de données, actualisations, dbt, SQL, visualisations, gouvernance, et plus. C'est ainsi que votre harness atteint cette plateforme : le serveur MCP que votre agent pilote est une enveloppe autour de cette API, et les SDKs sont la façon dont votre propre code interroge la plateforme et intègre les tableaux de bord que vos agents y publient. Il y a deux niveaux :
- L'API authentifiée, accessible via les SDKs officiels avec une clé API. C'est la surface complète orientée utilisateur.
- Une surface publique, sans authentification sous
/v1/public/*pour lire des visualisations publiées — les mêmes données que consomment vos tableaux de bord intégrés.
La surface des SDKs est l'API programmatique. La plomberie interne (admin, websocket, invocation directe, suivi d'usage), les flux de facturation/portail, et les fonctionnalités propres à l'application (notifications, retours, image de marque du compte, configuration des e-mails) sont exclus — ils sont pilotés par l'interface de l'application, pas par l'API publique.
URL de base
https://api.vibedasher.com/api
C'est la seule adresse dont vous avez besoin. L'edge placé devant lit votre identifiant et transmet la requête à la région qui héberge les données de votre compte : vous n'avez donc pas à savoir laquelle — voir Un seul hôte, routé par votre identifiant.
Chaque région répond aussi sur son propre nom d'hôte,
https://api.{region}.vibedasher.com/api. Ces adresses sont pleinement prises en
charge, et c'est par elles qu'on épingle délibérément un client à une seule
région. Pour un déploiement auto-hébergé, substituez votre propre hôte API.
Authentification
L'API authentifiée utilise une clé API envoyée dans l'en-tête X-Api-Key — générez-en
une dans l'application sous Paramètres → Clés API. (La création de clé se fait uniquement
en session et n'est pas appelable avec une clé.) Voir
Authentification pour les détails.
Si vous atteignez la plateforme depuis votre agent via MCP plutôt que depuis votre propre
code, vous n'avez besoin d'aucune clé : vibedasher login (dans vibedasher-mcp
0.6.0 ou ultérieure) vous connecte via le navigateur. Voir
Construire avec votre agent.
Les endpoints /v1/public/* ci-dessous ne requièrent aucune authentification.
Endpoints publics (sans authentification)
Pour lire des visualisations publiées et publiques :
| Méthode | Chemin | Objet |
|---|---|---|
GET | /v1/public/viz/slug/{slug} | Récupérer une viz publiée par slug |
GET | /v1/public/viz/{account_slug}/{slug} | Récupérer une viz publiée par compte + slug |
POST | /v1/public/viz/{account_slug}/{slug}/query | Exécuter une requête de viz |
Seules les visualisations publiées et marquées publiques sont accessibles via ces routes — les brouillons et les tableaux de bord privés renvoient 404.
Schéma OpenAPI et génération de code
L'API authentifiée complète est décrite par une spécification OpenAPI 3.0 versionnée
(Vibedasher SDK API, v2.0.0). Les SDKs officiels sont générés à partir d'elle, le chemin
le plus simple est donc d'utiliser les SDKs plutôt que d'assembler un client à la main :
- TypeScript —
npm install @vibedasher/client - Python —
pip install vibedasher
Voir SDKs pour l'usage. Si vous avez besoin d'un client dans un autre langage, générez-en un à partir de la même spécification OpenAPI avec le générateur de votre choix.
Parcourir chaque endpoint
La référence complète, endpoint par endpoint — chaque opération groupée par ressource (jeux de données, connexions, viz, questions, …) avec des exemples de requêtes curl / Python / TypeScript — se trouve dans la Référence API.
Prochaines étapes
- SDKs — les clients officiels TypeScript et Python.
- Authentification — clés API et surface publique.
- Référence API — chaque endpoint, avec des exemples de code.
- Intégrer un tableau de bord — déposer un tableau de bord publié dans votre propre application, publiquement ou verrouillé par visionneur avec des filtres au niveau des lignes.