Skip to main content

API overview

Vibedasher exposes a programmatic API for the platform — datasets, SQL, visualizations, connections, AI chat, and more. There are two tiers:

  1. The authenticated API, accessed through the official SDKs with an API key. This is the full user-facing surface.
  2. A public, no-auth surface under /v1/public/* for reading published visualizations — the same data your embedded dashboards consume.

The SDK surface is the programmatic API. Internal plumbing (admin, websocket, direct invoke, usage tracking), billing/portal flows, and in-app-only features (notifications, feedback, account branding, email config) are excluded — they're driven by the app UI, not the public API.

Base URL​

The cloud API is region-routed:

https://api.{region}.vibedasher.com

region is eu-central-1 — pick the region hosting your account's data. For a self-hosted deployment, substitute your own API host.

Authentication​

The authenticated API uses an API key sent in the X-Api-Key header. Mint a key via POST /v1/api-keys (from the app or the API). See Authentication for details.

The /v1/public/* endpoints below require no authentication.

Public endpoints (no auth)​

For reading published, public visualizations:

MethodPathPurpose
GET/v1/public/viz/slug/{slug}Fetch a published viz by slug
GET/v1/public/viz/{account_slug}/{slug}Fetch a published viz by account + slug
POST/v1/public/viz/{account_slug}/{slug}/queryRun a viz query
GET/v1/public/seedsList public seed templates

Only visualizations that are published and marked public are reachable through these routes — drafts and private dashboards return 404.

OpenAPI schema & codegen​

The full authenticated API is described by a committed OpenAPI 3.0 spec (Vibedasher SDK API, v2.0.0). The official SDKs are generated from it, so the simplest path is to use the SDKs rather than hand-rolling a client:

  • TypeScript — npm install @vibedasher/sdk
  • Python — pip install vibedasher

See SDKs for usage. If you need a client in another language, generate one from the same OpenAPI spec with the generator of your choice.

Browse every endpoint​

The complete, per-endpoint reference — every operation grouped by resource (datasets, connections, vizs, questions, …) with curl / Python / TypeScript request samples — lives in the API Reference.

Next steps​