Visión general de la API
Vibedasher expone una API programática para toda la plataforma mantenida — conexiones, conjuntos de datos, actualizaciones, dbt, SQL, visualizaciones, gobernanza, y más. Así es como tu agente alcanza esa plataforma: el servidor MCP que maneja tu agente es una envoltura sobre esta API, y los SDKs son cómo tu propio código consulta la plataforma e incrusta los paneles que tus agentes publican en ella. Hay dos niveles:
- La API autenticada, accesible a través de los SDKs oficiales con una clave de API. Esta es la superficie completa de cara al usuario.
- Una superficie pública, sin autenticación bajo
/v1/public/*para leer visualizaciones publicadas — los mismos datos que consumen tus paneles incrustados.
La superficie del SDK es la API programática. La fontanería interna (admin, websocket, invocación directa, seguimiento de uso), los flujos de facturación/portal, y las funcionalidades solo de la aplicación (notificaciones, feedback, marca de cuenta, configuración de correo) están excluidas — se manejan desde la interfaz de la aplicación, no desde la API pública.
URL base
https://api.vibedasher.com/api
Es la única dirección que necesitas. El edge que está delante lee tu credencial y reenvía la petición a la región que aloja los datos de tu cuenta, así que no tienes que saber cuál es — mira Un solo host, enrutado por tu credencial.
Cada región responde además en su propio nombre de host,
https://api.{region}.vibedasher.com/api. Están totalmente admitidos, y son la
forma de fijar un cliente a una sola región a propósito. Para un despliegue
autoalojado, sustituye por tu propio host de API.
Autenticación
La API autenticada usa una clave de API enviada en la cabecera X-Api-Key — genera una
en la aplicación bajo Ajustes → Claves de API. (La creación de claves es solo de sesión y no
se puede llamar con una clave.) Mira Autenticación para más
detalles.
Si estás llegando a la plataforma desde tu agente por MCP en lugar de desde tu propio
código, no necesitas ninguna clave: vibedasher login (en vibedasher-mcp 0.6.0 o
posterior) te inicia sesión a través del navegador. Mira
Construir con tu agente.
Los endpoints /v1/public/* de abajo no requieren ninguna autenticación.
Endpoints públicos (sin autenticación)
Para leer visualizaciones publicadas y públicas:
| Método | Ruta | Propósito |
|---|---|---|
GET | /v1/public/viz/slug/{slug} | Obtener una viz publicada por slug |
GET | /v1/public/viz/{account_slug}/{slug} | Obtener una viz publicada por cuenta + slug |
POST | /v1/public/viz/{account_slug}/{slug}/query | Ejecutar una consulta de viz |
Solo son alcanzables por estas rutas las visualizaciones que están publicadas y marcadas como públicas — los borradores y paneles privados devuelven 404.
Esquema OpenAPI y codegen
La API autenticada completa está descrita por una especificación OpenAPI 3.0 versionada
(Vibedasher SDK API, v2.0.0). Los SDKs oficiales se generan a partir de ella, así que el
camino más simple es usar los SDKs en lugar de construir un cliente a mano:
- TypeScript —
npm install @vibedasher/client - Python —
pip install vibedasher
Mira SDKs para su uso. Si necesitas un cliente en otro lenguaje, genera uno a partir de la misma especificación OpenAPI con el generador que prefieras.
Explora cada endpoint
La referencia completa, endpoint por endpoint — cada operación agrupada por recurso (conjuntos de datos, conexiones, vizs, preguntas, …) con ejemplos de petición en curl / Python / TypeScript — vive en la API Reference.
Próximos pasos
- SDKs — los clientes oficiales de TypeScript y Python.
- Autenticación — claves de API y la superficie pública.
- API Reference — cada endpoint, con ejemplos de código.
- Incrustar un panel — pon un panel publicado en tu propia aplicación, públicamente o protegido por visor con filtros a nivel de fila.