Reference

Two generated references, for the two ways you talk to Ridge:

• REST API — the HTTP endpoints your backend calls: read a dashboard, download a datasource's active dataset, and mint an embed token. Rendered from the OpenAPI spec the API itself is served against, and downloadable as openapi.json for client generation.
• Embed SDK (the pages below) — the browser-side JavaScript surface for putting a dashboard in your product.

If your backend mints embed tokens, you need both: the REST reference for POST /api/embed/token, then the SDK reference for what to do with the token in the browser.

Embed SDK

The pages under Embed API are generated from a curated entry point over the embed sources. It exposes the supported inline handle, shared state values, and iframe message protocol without publishing the monorepo's internal validators and HTTP transport types.

Start with the guides if you're integrating for the first time:

• Getting started
• Iframe quickstart
• Inline quickstart
• Dashboard state
• Filters
• Partitioning
• Events
• Theming

How to read these pages

• RidgeEmbed is the handle returned by the inline loader and embed().
• EmbedOptions is what you pass in.
• EmbedMessage and the message unions describe optional iframe control.
• The State* types are shared by the inline API, iframe protocol, and encoded initial state.

Editing

Don't edit these pages by hand — they're regenerated and your changes will be overwritten. Fix the doc comment in the source instead.