Visão geral da API
A Vibedasher expõe uma API programática para toda a plataforma mantida — conexões, conjuntos de dados, atualizações, dbt, SQL, visualizações, governança e mais. É assim que seu agente de IA alcança essa plataforma: o servidor MCP que seu agente conduz é um invólucro sobre essa API, e os SDKs são como seu próprio código consulta a plataforma e incorpora os painéis que seus agentes publicam nela. Existem duas camadas:
- A API autenticada, acessada através dos SDKs oficiais com uma chave de API. Essa é a superfície completa voltada ao usuário.
- Uma superfície pública, sem autenticação, sob
/v1/public/*, para ler visualizações publicadas — os mesmos dados que seus painéis incorporados consomem.
A superfície do SDK é a API programática. Mecanismos internos (admin, websocket, invocação direta, rastreamento de uso), fluxos de cobrança/portal, e recursos exclusivos do app (notificações, feedback, identidade visual da conta, configuração de e-mail) são excluídos — eles são conduzidos pela interface do app, não pela API pública.
URL base
https://api.vibedasher.com/api
É o único endereço de que você precisa. O edge na frente lê a sua credencial e encaminha a requisição para a região que hospeda os dados da sua conta, então você não precisa saber qual é — veja Um só host, roteado pela sua credencial.
Cada região também responde no seu próprio hostname,
https://api.{region}.vibedasher.com/api. Eles têm suporte completo, e são como
se fixa um cliente a uma única região de propósito. Para uma implantação
auto-hospedada, substitua pelo seu próprio host de API.
Autenticação
A API autenticada usa uma chave de API enviada no cabeçalho X-Api-Key — gere uma no app
em Configurações → Chaves de API. (A criação de chave é somente por sessão e não pode ser
chamada com uma chave.) Veja Autenticação para detalhes.
Se você está alcançando a plataforma a partir do seu agente via MCP, em vez do seu próprio
código, você não precisa de chave nenhuma: vibedasher login (em vibedasher-mcp 0.6.0 ou
superior) faz seu login através do navegador. Veja
Construa com seu agente.
Os endpoints /v1/public/* abaixo não exigem nenhuma autenticação.
Endpoints públicos (sem autenticação)
Para ler visualizações publicadas e públicas:
| Método | Caminho | Finalidade |
|---|---|---|
GET | /v1/public/viz/slug/{slug} | Buscar uma viz publicada pelo slug |
GET | /v1/public/viz/{account_slug}/{slug} | Buscar uma viz publicada por conta + slug |
POST | /v1/public/viz/{account_slug}/{slug}/query | Executar uma consulta de viz |
Somente visualizações que estão publicadas e marcadas como públicas são acessíveis através dessas rotas — drafts e painéis privados retornam 404.
Esquema OpenAPI e geração de código
A API autenticada completa é descrita por uma especificação OpenAPI 3.0 versionada
(Vibedasher SDK API, v2.0.0). Os SDKs oficiais são gerados a partir dela, então o caminho mais
simples é usar os SDKs em vez de construir um cliente na mão:
- TypeScript —
npm install @vibedasher/client - Python —
pip install vibedasher
Veja SDKs para uso. Se você precisa de um cliente em outra linguagem, gere um a partir da mesma especificação OpenAPI com o gerador da sua escolha.
Navegue por todos os endpoints
A referência completa, por endpoint — cada operação agrupada por recurso (conjuntos de dados, conexões, vizs, questions, …) com exemplos de requisição em curl / Python / TypeScript — vive na Referência da API.
Próximos passos
- SDKs — os clientes oficiais para TypeScript e Python.
- Autenticação — chaves de API e a superfície pública.
- Referência da API — todos os endpoints, com exemplos de código.
- Incorporando um painel — coloque um painel publicado no seu próprio app, publicamente ou controlado por visualizador com filtros por linha.