# Ridge AI

> Guides and API reference for embedding Ridge AI dashboards in your product.

Build dashboards with AI and embed them in your app.

## Table of Contents

### Start here

- [What is Ridge?](https://docs.ridgedata.ai/guide/introduction.md)
- [Choose an embed](https://docs.ridgedata.ai/guide/getting-started.md)

### Iframe embed

- [Iframe quickstart](https://docs.ridgedata.ai/guide/iframe.md)
- [Iframe authentication](https://docs.ridgedata.ai/guide/iframe-authentication.md)

### JavaScript embed

- [JavaScript embed quickstart](https://docs.ridgedata.ai/guide/javascript.md)
- [JavaScript authentication](https://docs.ridgedata.ai/guide/javascript-authentication.md)

### Shared concepts

- [Dashboard state](https://docs.ridgedata.ai/guide/state.md)
- [Filters](https://docs.ridgedata.ai/guide/filters.md)
- [Partitioning](https://docs.ridgedata.ai/guide/partitioning.md)
- [Events](https://docs.ridgedata.ai/guide/events.md)
- [Theming](https://docs.ridgedata.ai/guide/theming.md)

### Reference

- [Reference](https://docs.ridgedata.ai/reference.md)
- [REST API](https://docs.ridgedata.ai/reference/rest.md): HTTP endpoints for dashboards, datasource data, and embed tokens.

### JavaScript API

- [Interface: RidgeEmbed](https://docs.ridgedata.ai/reference/embed-api/Interface.RidgeEmbed.md)
- [Interface: RidgeEmbedEventMap](https://docs.ridgedata.ai/reference/embed-api/Interface.RidgeEmbedEventMap.md)
- [Interface: EmbedOptions](https://docs.ridgedata.ai/reference/embed-api/Interface.EmbedOptions.md)
- [Type Alias: FilterValues](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.FilterValues.md)
- [Interface: FilterUpdateResult](https://docs.ridgedata.ai/reference/embed-api/Interface.FilterUpdateResult.md)
- [Interface: FilterChangeEvent](https://docs.ridgedata.ai/reference/embed-api/Interface.FilterChangeEvent.md)
- [Interface: StateChangeEvent](https://docs.ridgedata.ai/reference/embed-api/Interface.StateChangeEvent.md)
- [Interface: StateUpdateResult](https://docs.ridgedata.ai/reference/embed-api/Interface.StateUpdateResult.md)
- [Interface: StateWriteOptions](https://docs.ridgedata.ai/reference/embed-api/Interface.StateWriteOptions.md)
- [Function: embed()](https://docs.ridgedata.ai/reference/embed-api/Function.embed.md)
- [Function: embedStateToParams()](https://docs.ridgedata.ai/reference/embed-api/Function.embedStateToParams.md)
- [Function: parseEmbedState()](https://docs.ridgedata.ai/reference/embed-api/Function.parseEmbedState.md)

### Iframe protocol

- [Variable: EmbedMessage](https://docs.ridgedata.ai/reference/embed-api/Variable.EmbedMessage.md)
- [Type Alias: HostToEmbedMessage](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.HostToEmbedMessage.md)
- [Type Alias: EmbedToHostMessage](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.EmbedToHostMessage.md)
- [Type Alias: EmbedProtocolMessage](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.EmbedProtocolMessage.md)
- [Function: isEmbedProtocolMessage()](https://docs.ridgedata.ai/reference/embed-api/Function.isEmbedProtocolMessage.md)

### Shared values

- [Type Alias: StateValues](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.StateValues.md)
- [Type Alias: ComponentState](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.ComponentState.md)
- [Type Alias: StateSchema](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.StateSchema.md)
- [Type Alias: StateValueSchema](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.StateValueSchema.md)
- [Interface: StateError](https://docs.ridgedata.ai/reference/embed-api/Interface.StateError.md)
- [Type Alias: StateErrorCode](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.StateErrorCode.md)
- [Type Alias: JsonValue](https://docs.ridgedata.ai/reference/embed-api/TypeAlias.JsonValue.md)

### Other

- [@ridge-ai/docs](https://docs.ridgedata.ai/reference/embed-api/README.md)