Panoramica dell'API
Vibedasher espone un'API programmatica per l'intera piattaforma gestita — connessioni, dataset, aggiornamenti, dbt, SQL, visualizzazioni, governance e altro. È così che il tuo harness raggiunge quella piattaforma: il server MCP guidato dal tuo agente è un wrapper su questa API, e gli SDK sono il modo in cui il tuo stesso codice interroga la piattaforma e incorpora le dashboard che i tuoi agenti vi pubblicano. Ci sono due livelli:
- L'API autenticata, raggiunta attraverso gli SDK ufficiali con una chiave API. Questa è l'intera superficie rivolta all'utente.
- Una superficie pubblica, senza autenticazione sotto
/v1/public/*per leggere visualizzazioni pubblicate — gli stessi dati che le tue dashboard incorporate consumano.
La superficie SDK è l'API programmatica. L'idraulica interna (admin, websocket, invocazione diretta, tracciamento dell'uso), i flussi di fatturazione/portale, e le funzionalità solo nell'app (notifiche, feedback, branding dell'account, configurazione email) sono esclusi — sono guidati dall'interfaccia dell'app, non dall'API pubblica.
URL di base
https://api.vibedasher.com/api
È il solo indirizzo che ti serve. L'edge davanti legge la tua credenziale e inoltra la richiesta alla regione che ospita i dati del tuo account, quindi non devi sapere quale sia — vedi Un solo host, instradato dalla tua credenziale.
Ogni regione risponde anche sul proprio hostname,
https://api.{region}.vibedasher.com/api. Sono pienamente supportati, e sono il
modo per fissare un client a una sola regione di proposito. Per
un'installazione self-hosted, sostituisci con il tuo host API.
Autenticazione
L'API autenticata usa una chiave API inviata nell'header X-Api-Key — generane una
nell'app sotto Impostazioni → Chiavi API. (La creazione della chiave è solo di sessione e
non è invocabile con una chiave.) Vedi Autenticazione per i
dettagli.
Se raggiungi la piattaforma dal tuo agente via MCP invece che dal tuo stesso codice, non
hai bisogno di alcuna chiave: vibedasher login (in vibedasher-mcp 0.6.0 o versioni
successive) ti fa accedere attraverso il browser. Vedi
Crea con il tuo agente.
Gli endpoint /v1/public/* sotto non richiedono alcuna autenticazione.
Endpoint pubblici (senza autenticazione)
Per leggere visualizzazioni pubblicate e pubbliche:
| Metodo | Percorso | Scopo |
|---|---|---|
GET | /v1/public/viz/slug/{slug} | Recupera una viz pubblicata per slug |
GET | /v1/public/viz/{account_slug}/{slug} | Recupera una viz pubblicata per account + slug |
POST | /v1/public/viz/{account_slug}/{slug}/query | Esegui una query sulla viz |
Solo le visualizzazioni che sono pubblicate e contrassegnate come pubbliche sono raggiungibili attraverso queste route — draft e dashboard private restituiscono 404.
Schema OpenAPI e generazione del codice
L'intera API autenticata è descritta da una specifica OpenAPI 3.0 tracciata
(Vibedasher SDK API, v2.0.0). Gli SDK ufficiali sono generati a partire da essa,
quindi il percorso più semplice è usare gli SDK invece di costruire un client a mano:
- TypeScript —
npm install @vibedasher/client - Python —
pip install vibedasher
Vedi SDK per l'uso. Se hai bisogno di un client in un altro linguaggio, generane uno dalla stessa specifica OpenAPI con il generatore che preferisci.
Esplora ogni endpoint
Il riferimento completo, per ogni endpoint — ogni operazione raggruppata per risorsa (dataset, connessioni, viz, questions, …) con esempi di richiesta curl / Python / TypeScript — si trova nel Riferimento API.
Passi successivi
- SDK — i client ufficiali TypeScript e Python.
- Autenticazione — chiavi API e la superficie pubblica.
- Riferimento API — ogni endpoint, con esempi di codice.
- Incorporare una dashboard — inserisci una dashboard pubblicata nella tua stessa app, pubblicamente o vincolata per singolo visualizzatore con filtri per riga.