Developers overview

The Flax programmatic surface — a REST API, an MCP server, and embedding — for building on top of your warehouse-native BI

Flax exposes everything the app does through a programmatic surface, so you can automate modelling, run queries, build charts and dashboards, and embed them in your own products. This section is for developers and platform teams.

#The three surfaces

  • REST API — the foundation. Every capability is a JSON HTTP endpoint under /api. Charts, dashboards, sheets, queries, connections, and models are all created and read the same way the app does it. See the API reference.
  • MCP server — the same API wrapped as Model Context Protocol tools, so agents like Claude can discover your semantic layers, validate queries, and assemble charts and dashboards for you.
  • Embedding — put a chart or dashboard inside another application, either as an iframe or a static PNG.

#Base URL

The API is served from your Flax host under /api. If your instance is at https://flax.example.com, the base URL is:

https://flax.example.com/api

All examples in this section use that origin as a placeholder — substitute your own host.

#Authentication at a glance

  • Automations and scripts authenticate with a service-account API token (flax_pat_…) sent as a bearer token. See Authentication.
  • MCP clients that need an interactive, delegated login use the built-in OAuth authorization server.

Every request is authorized by the caller's scopes and by the same team and row-level-security rules as the app — the programmatic surface grants no extra privilege.

#Next steps