API-Übersicht
Vibedasher stellt eine programmatische API für die gesamte betriebene Plattform bereit — Verbindungen, Datensätze, Aktualisierungen, dbt, SQL, Visualisierungen, Governance und mehr. So erreicht Ihr Harness diese Plattform: Der MCP-Server, den Ihr Agent steuert, ist ein Wrapper über dieser API, und die SDKs sind der Weg, wie Ihr eigener Code die Plattform abfragt und die Dashboards einbettet, die Ihre Agenten dort veröffentlichen. Es gibt zwei Stufen:
- Die authentifizierte API, zugänglich über die offiziellen SDKs mit einem API-Schlüssel. Das ist die vollständige benutzerseitige Oberfläche.
- Eine öffentliche No-Auth-Oberfläche unter
/v1/public/*zum Lesen veröffentlichter Visualisierungen — dieselben Daten, die Ihre eingebetteten Dashboards konsumieren.
Die SDK-Oberfläche ist die programmatische API. Interne Verwaltung (Admin, Websocket, direkter Aufruf, Nutzungsverfolgung), Abrechnungs-/Portal-Abläufe und rein In-App-Funktionen (Benachrichtigungen, Feedback, Kontomarkierung, E-Mail-Konfiguration) sind ausgeschlossen — sie werden von der App-Benutzeroberfläche gesteuert, nicht von der öffentlichen API.
Basis-URL
https://api.vibedasher.com/api
Das ist die einzige Adresse, die Sie brauchen. Der davorliegende Edge liest Ihren Zugangsnachweis und leitet die Anfrage an die Region weiter, die die Daten Ihres Kontos hält — Sie müssen also nicht wissen, welche das ist. Siehe Ein Host, geroutet über Ihren Zugangsnachweis.
Jede Region antwortet auch auf ihrem eigenen Hostnamen,
https://api.{region}.vibedasher.com/api. Diese werden voll unterstützt, und mit
ihnen binden Sie einen Client absichtlich an eine einzige Region. Für eine
selbst gehostete Bereitstellung ersetzen Sie diese durch Ihren eigenen
API-Host.
Authentifizierung
Die authentifizierte API verwendet einen API-Schlüssel, der im
X-Api-Key-Header gesendet wird — erzeugen Sie einen in der App unter
Einstellungen → API-Schlüssel. (Die Schlüsselerstellung ist nur per Sitzung möglich und
nicht mit einem Schlüssel aufrufbar.) Siehe
Authentifizierung für Details.
Wenn Sie die Plattform von Ihrem Agenten über MCP erreichen, statt von Ihrem eigenen Code
aus, brauchen Sie überhaupt keinen Schlüssel: vibedasher login (in vibedasher-mcp
0.6.0 oder höher) meldet Sie über den Browser an. Siehe
Mit Ihrem Agenten bauen.
Die unten stehenden /v1/public/*-Endpunkte erfordern keine Authentifizierung.
Öffentliche Endpunkte (ohne Authentifizierung)
Zum Lesen veröffentlichter, öffentlicher Visualisierungen:
| Methode | Pfad | Zweck |
|---|---|---|
GET | /v1/public/viz/slug/{slug} | Eine veröffentlichte Visualisierung per Slug abrufen |
GET | /v1/public/viz/{account_slug}/{slug} | Eine veröffentlichte Visualisierung per Konto + Slug abrufen |
POST | /v1/public/viz/{account_slug}/{slug}/query | Eine Visualisierungsabfrage ausführen |
Nur Visualisierungen, die veröffentlicht und als öffentlich markiert sind, sind über diese Routen erreichbar — Entwürfe und private Dashboards liefern 404.
OpenAPI-Schema & Codegen
Die vollständige authentifizierte API wird durch eine versionierte OpenAPI-3.0-Spezifikation
beschrieben (Vibedasher SDK API, v2.0.0). Die offiziellen SDKs werden daraus generiert,
sodass der einfachste Weg ist, die SDKs zu verwenden, statt einen Client von Hand zu
bauen:
- TypeScript —
npm install @vibedasher/client - Python —
pip install vibedasher
Siehe SDKs für die Verwendung. Wenn Sie einen Client in einer anderen Sprache benötigen, generieren Sie einen aus derselben OpenAPI-Spezifikation mit dem Generator Ihrer Wahl.
Jeden Endpunkt durchsuchen
Die vollständige, endpunktweise Referenz — jede Operation gruppiert nach Ressource (Datensätze, Verbindungen, Vizs, Questions, …) mit curl-/Python-/TypeScript-Anfragebeispielen — befindet sich in der API Reference.
Nächste Schritte
- SDKs — die offiziellen TypeScript- und Python-Clients.
- Authentifizierung — API-Schlüssel und die öffentliche Oberfläche.
- API Reference — jeder Endpunkt, mit Codebeispielen.
- Ein Dashboard einbetten — ein veröffentlichtes Dashboard in Ihre eigene App einbetten, öffentlich oder pro Betrachter mit zeilenbasierten Filtern gesichert.