# Omni Docs: Developers

## Developers

- [Developers / REST APIs (208 pages)](https://docs.omni.co/_llms/developers/rest-apis.md): Programmatically interact with Omni

### Embedding

#### Getting started

- [Embedding Omni in external applications](https://docs.omni.co/embed/index.md): Embed Omni dashboards and analytics in external applications with row-level permissions, SSO, and full theme customization.
- [Embedding Omni quickstart](https://docs.omni.co/embed/quickstart.md): Get up and running with your embedded Omni application.
- [Embedding Omni best practices](https://docs.omni.co/embed/best-practices.md): Learn how to develop a secure, enjoyable embedded Omni experience for your users.
- [Embedding limitations](https://docs.omni.co/embed/limitations.md): Understand current limitations of Omni embedding, including session length, supported browsers, content types, and feature gaps.

#### Setup

- [Generating embedded user sessions](https://docs.omni.co/embed/setup/index.md): Set up your embedding infrastructure and generate user sessions.

##### Generate user sessions

- [Setting up embed with 2-step SSO](https://docs.omni.co/embed/setup/two-step-sso.md): Set up 2-step SSO for Omni embedding using a POST request to generate a session token, then redeem it via a login URL.

###### Standard SSO

- [Embed standard SSO](https://docs.omni.co/embed/setup/standard-sso/index.md): Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.
- [Setting up embed standard SSO with the v1 signing payload format](https://docs.omni.co/embed/setup/standard-sso/latest.md): Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.
- [Migrating to the v1 embed standard SSO signing format](https://docs.omni.co/embed/setup/standard-sso/migrate-to-latest.md): Learn what changed in the v1 embed standard SSO signing format and how to update your code from v0.
- [Embed standard SSO - Legacy v0 signing format](https://docs.omni.co/embed/setup/standard-sso/v0-legacy.md): Reference for the deprecated v0 embed URL signing format, in which each parameter is sent as its own URL parameter alongside a signature.

##### Customize users & sessions

- [Customizing embed users and sessions with URL parameters](https://docs.omni.co/embed/setup/customize.md): Customize embed users and sessions with Omni embed parameters.
- [Testing embed URL parameters with the URL builder](https://docs.omni.co/embed/setup/test-urls.md): Use the embed URL builder to test and generate embed URLs for internal use.

###### URL parameters

- [Embed URL parameters reference](https://docs.omni.co/embed/setup/url-parameters/index.md): Create and customize user sessions by including URL parameters in your embed requests.
- [accessBoost](https://docs.omni.co/embed/setup/url-parameters/accessBoost.md): Enables AccessBoost for the embedded dashboard.
- [connectionRoles](https://docs.omni.co/embed/setup/url-parameters/connectionRoles.md): Specifies the level of access users will have to all models associated with a connection.
- [contentPath](https://docs.omni.co/embed/setup/url-parameters/contentPath.md): Defines the starting page when the embed user logs into the iframe.
- [customTheme](https://docs.omni.co/embed/setup/url-parameters/customTheme.md): Defines custom theme properties for styling embedded dashboards.
- [customThemeId](https://docs.omni.co/embed/setup/url-parameters/customThemeId.md): Specifies the custom theme to use in the resulting embed session. Used to apply your own custom styles.
- [email](https://docs.omni.co/embed/setup/url-parameters/email.md): Populates the from email for entity users when sharing content or sending deliveries.
- [entity](https://docs.omni.co/embed/setup/url-parameters/entity.md): Defines a user group identifier used to associate the resulting embed user with a larger group.
- [entityAiCreditLimit](https://docs.omni.co/embed/setup/url-parameters/entityAiCreditLimit.md): Sets an AI credit limit for the embed user's entity group at login.
- [entityFolderContentRole](https://docs.omni.co/embed/setup/url-parameters/entityFolderContentRole.md): Specifies the content role the embed user will be given to their shared entity folder.
- [entityFolderGroupContentRole](https://docs.omni.co/embed/setup/url-parameters/entityFolderGroupContentRole.md): Specifies the content role the embed entity group will be given to their shared entity folder.
- [entityFolderLabel](https://docs.omni.co/embed/setup/url-parameters/entityFolderLabel.md): Updates the embed user's associated entity folder label.
- [entityGroupLabel](https://docs.omni.co/embed/setup/url-parameters/entityGroupLabel.md): Updates the embed user's associated entity group label.
- [externalId](https://docs.omni.co/embed/setup/url-parameters/externalId.md): Creates a unique ID for the embed user.
- [filterSearchParam](https://docs.omni.co/embed/setup/url-parameters/filterSearchParam.md): Specifies the filters to apply for the embedded content.
- [groups](https://docs.omni.co/embed/setup/url-parameters/groups.md): Associates the resulting embed user with existing user groups in your Omni instance.
- [linkAccess](https://docs.omni.co/embed/setup/url-parameters/linkAccess.md): Controls which Omni dashboards can be linked to from the embedded dashboard.
- [mode](https://docs.omni.co/embed/setup/url-parameters/mode.md): Defines the type of access users will have to Omni in the iframe.
- [modelRoles](https://docs.omni.co/embed/setup/url-parameters/modelRoles.md): Defines the level of access users will have for individual models in a connection.
- [name](https://docs.omni.co/embed/setup/url-parameters/name.md): Defines a non-unique name for the embed user's name property.
- [nonce](https://docs.omni.co/embed/setup/url-parameters/nonce.md): A unique 32-character string that defines the embed login URL.
- [prefersDark](https://docs.omni.co/embed/setup/url-parameters/prefersDark.md): Controls whether the resulting embed session has a light or dark mode appearance.
- [preserveEntityFolderContentRole](https://docs.omni.co/embed/setup/url-parameters/preserveEntityFolderContentRole.md): Retains the embed user's existing entity folder content role.
- [theme](https://docs.omni.co/embed/setup/url-parameters/theme.md): Customizes the styles of the resulting embed session with a built-in Omni application theme.
- [timezone](https://docs.omni.co/embed/setup/url-parameters/timezone.md): Specifies a timezone override for query execution in the embedded session.
- [uiSettings](https://docs.omni.co/embed/setup/url-parameters/uiSettings.md): Controls general settings of the application in embed.
- [userAttributes](https://docs.omni.co/embed/setup/url-parameters/userAttributes.md): Applies user attributes to the embed user.

#### App customization

- [Enabling iframe-restricted functionality for embedded instances](https://docs.omni.co/embed/customization/iframes.md): Enable functionality for embedded content that iframes restrict by default.
- [Setting up custom domains for embed](https://docs.omni.co/embed/customization/vanity-domains.md): Set up custom vanity domains for embedded Omni dashboards to enable first-party cookies and cohesive branding across content.
- [Create Mode for embedded analytics](https://docs.omni.co/embed/customization/create-mode.md): Enable the full Omni experience - creating, sharing, and navigating content - for your embedded users.
- [Applying custom themes and sidebars to embedded Omni](https://docs.omni.co/embed/customization/themes.md): Create a seamless, cohesive analytics experience for your users with a custom theme and navigation sidebar.
- [Embedding the Omni Agent](https://docs.omni.co/embed/customization/ai-chat.md): Integrate a whitelabeled version of the Omni Agent directly into your embedded application.
- [Configuring email deliveries in embedded Omni](https://docs.omni.co/embed/customization/deliveries.md): Allow users in your embedded Omni instance to schedule or set alerts on documents.
- [Linking to other content in embedded Omni](https://docs.omni.co/embed/customization/link-content.md): Add interactivity to your embedded Omni application by linking to other content.

#### Events & interactivity

- [Embed events](https://docs.omni.co/embed/events/index.md): Build interactive experiences in your embedded Omni application with JavaScript events.
- [Sending embed events to Omni](https://docs.omni.co/embed/events/send.md): Trigger actions in an embedded Omni application by sending events into the Omni iframe.
- [Consuming embed events sent by Omni](https://docs.omni.co/embed/events/consume.md): Consume events emitted by Omni to trigger interactions in your application.
- [Sending embed events from Omni visualizations](https://docs.omni.co/embed/events/visualizations.md): Trigger actions in your application by emitting events from embedded Omni table and Markdown visualizations.

##### Supported events

- [ai:chat-start embed event](https://docs.omni.co/embed/events/ai-chat-start.md): Emitted by Omni when an AI chat session begins.
- [app:event embed event](https://docs.omni.co/embed/events/app-event.md): Emitted by an embedded Omni app when its code calls omni.emit, so your page can react to what happens inside the app.
- [app:filter-changed embed event](https://docs.omni.co/embed/events/app-filter-changed.md): Emitted by Omni when an embedded app changes the filters on one of its queries.
- [appearance:mode embed event](https://docs.omni.co/embed/events/appearance-mode.md): Triggers a color scheme change of the embedded Omni session.
- [dashboard:download embed event](https://docs.omni.co/embed/events/dashboard-download.md): Emitted by Omni when a user downloads an embedded dashboard.
- [dashboard:filters embed event](https://docs.omni.co/embed/events/dashboard-filters.md): Emitted by Omni when a user applies a filter to an embedded document.
- [dashboard:filter-changed embed event](https://docs.omni.co/embed/events/dashboard-filter-changed.md): Emitted by Omni when a user adds, removes, or updates a filter on an embedded document.
- [dashboard:filter-change-by-url-parameter embed event](https://docs.omni.co/embed/events/dashboard-filter-change-by-url-parameter.md): Triggers the change of a filter value on an embedded dashboard.
- [dashboard:tile-download embed event](https://docs.omni.co/embed/events/dashboard-tile-download.md): Emitted by Omni when a user downloads a given tile on a dashboard.
- [dashboard:tile-drill embed event](https://docs.omni.co/embed/events/dashboard-tile-drill.md): Emitted by Omni when a user performs a drill action on a dashboard tile.
- [error embed event](https://docs.omni.co/embed/events/error.md): Emitted by Omni when a detectable error occurs on an embedded page.
- [fullscreen:changed embed event](https://docs.omni.co/embed/events/fullscreen-changed.md): Emitted by Omni when the fullscreen state of an embedded dashboard or app changes.
- [fullscreen:set embed event](https://docs.omni.co/embed/events/fullscreen-set.md): Sets the fullscreen presentation state of the embedded Omni session.
- [navigate embed event](https://docs.omni.co/embed/events/navigate.md): Triggers a redirect to the path specified in the payload.
- [navigation:home embed event](https://docs.omni.co/embed/events/navigation-home.md): Emitted by Omni when a user clicks the logo or home link in the navigation header.
- [page:changed embed event](https://docs.omni.co/embed/events/page-changed.md): Emitted by Omni when the URL of a page changes.
- [sidebar:open embed event](https://docs.omni.co/embed/events/sidebar-open.md): Emitted by Omni when a user clicks the mobile menu button.
- [size embed event](https://docs.omni.co/embed/events/size.md): Emitted by Omni to give the size of embedded content, allowing you to dynamically size the iframe.
- [status embed event](https://docs.omni.co/embed/events/status.md): Emitted by Omni to indicate the status of the dashboard to the parent frame.

#### Admin

- [Embed administration](https://docs.omni.co/embed/admin/index.md): Manage embed secrets, security, users, entities, and sessions for your organization.
- [Managing embed secrets](https://docs.omni.co/embed/admin/secrets.md): Create, view, edit, and delete embed secrets for your organization.
- [Configuring security and access settings for embedded content](https://docs.omni.co/embed/admin/security.md): Control security and access restrictions for embedded content.
- [Managing user sessions](https://docs.omni.co/embed/admin/sessions.md): View and delete Omni embed user sessions.
- [Managing embed users](https://docs.omni.co/embed/admin/users.md): View, manage, and impersonate users in your embedded Omni application.
- [Managing embed entity groups](https://docs.omni.co/embed/admin/entities.md): View and manage embed entity groups in your embedded Omni application.
- [Managing AI credits for embed entity groups](https://docs.omni.co/embed/admin/ai-credits.md): Set default and per-group credit limits for embed entity groups.
- [Configuring embed integrations](https://docs.omni.co/embed/admin/integrations.md): Configure third-party integrations like FullStory and LogRocket for your embedded Omni instance.

### CLI

#### Getting started

- [Omni CLI](https://docs.omni.co/developers/cli/index.md): Manage your Omni instance from the terminal — query data, manage models, administer users, and automate workflows.
- [Installation - Omni CLI](https://docs.omni.co/developers/cli/install.md): Install the Omni CLI on macOS, Linux, or Windows.
- [Authentication - Omni CLI](https://docs.omni.co/developers/cli/authentication.md): Choose how to authenticate the Omni CLI with your instance: OAuth for streamlined setup or API keys for manual control.
- [Quickstart - Omni CLI](https://docs.omni.co/developers/cli/quickstart.md): Configure the Omni CLI and run your first commands.

#### Command groups

- [Command groups - Omni CLI](https://docs.omni.co/developers/cli/commands/index.md): How Omni CLI commands map to the API, and where to find each command group.
- [API tokens commands - Omni CLI](https://docs.omni.co/developers/cli/commands/api-tokens.md): Reference for the omni api-tokens command group: manage organization API tokens.
- [Connections commands - Omni CLI](https://docs.omni.co/developers/cli/commands/connections.md): Reference for the omni connections command group: database connections, dbt configuration, and schema refresh schedules.
- [Content commands - Omni CLI](https://docs.omni.co/developers/cli/commands/content.md): Reference for the omni content command group: list and search content.
- [Dashboards commands - Omni CLI](https://docs.omni.co/developers/cli/commands/dashboards.md): Reference for the omni dashboards command group: download dashboards and manage dashboard filters.
- [Documents commands - Omni CLI](https://docs.omni.co/developers/cli/commands/documents.md): Reference for the omni documents command group, including the v2 draft/publish and app content commands.
- [Embed commands - Omni CLI](https://docs.omni.co/developers/cli/commands/embed.md): Reference for the omni embed command group: generate embed SSO sessions.
- [Folders commands - Omni CLI](https://docs.omni.co/developers/cli/commands/folders.md): Reference for the omni folders command group: manage folders and folder permissions.
- [Labels commands - Omni CLI](https://docs.omni.co/developers/cli/commands/labels.md): Reference for the omni labels command group: create and manage content labels.
- [Models commands - Omni CLI](https://docs.omni.co/developers/cli/commands/models.md): Reference for the omni models command group: models, views, fields, topics, branches, and Git configuration.
- [Query commands - Omni CLI](https://docs.omni.co/developers/cli/commands/query.md): Reference for the omni query command group: run and monitor queries.
- [Schedules commands - Omni CLI](https://docs.omni.co/developers/cli/commands/schedules.md): Reference for the omni schedules command group: delivery schedules and recipients.
- [SCIM commands - Omni CLI](https://docs.omni.co/developers/cli/commands/scim.md): Reference for the omni scim command group: SCIM user and group provisioning.
- [Unstable commands - Omni CLI](https://docs.omni.co/developers/cli/commands/unstable.md): Reference for the omni unstable command group: preview commands that may change without notice.
- [Uploads commands - Omni CLI](https://docs.omni.co/developers/cli/commands/uploads.md): Reference for the omni uploads command group: manage CSV and Excel file uploads.
- [User attributes commands - Omni CLI](https://docs.omni.co/developers/cli/commands/user-attributes.md): Reference for the omni user-attributes command group: view user attribute definitions.
- [Users commands - Omni CLI](https://docs.omni.co/developers/cli/commands/users.md): Reference for the omni users command group: manage user and group model roles, email-only users, and user attribute values.
- [Whoami commands - Omni CLI](https://docs.omni.co/developers/cli/commands/whoami.md): Reference for the omni whoami command group: check the authenticated caller's identity and permissions.
- [Config and utility commands - Omni CLI](https://docs.omni.co/developers/cli/commands/utility.md): Manage CLI configuration profiles, and the agent-help, completion, and update utility commands.

##### AI

- [AI commands - Omni CLI](https://docs.omni.co/developers/cli/commands/ai.md): Reference for the omni ai command group: query generation, jobs, conversations, and credit controls.
- [AI Eval commands - Omni CLI](https://docs.omni.co/developers/cli/commands/ai-eval.md): Reference for the omni ai-eval command group: manage eval prompt sets and runs.
- [AI model suggestions commands - Omni CLI](https://docs.omni.co/developers/cli/commands/ai-model-suggestions.md): Reference for the omni ai-model-suggestions command group: generate and manage AI model suggestions.
- [AI routines commands - Omni CLI](https://docs.omni.co/developers/cli/commands/ai-routines.md): Reference for the omni ai-routines command group: manage AI routines.

#### Reference

- [Global flags - Omni CLI](https://docs.omni.co/developers/cli/reference/global-flags.md): Flags available on every Omni CLI command.
- [Output formats - Omni CLI](https://docs.omni.co/developers/cli/reference/output-formats.md): How the Omni CLI chooses between human-readable and JSON output, and how to control it.
- [Environment variables - Omni CLI](https://docs.omni.co/developers/cli/reference/environment-variables.md): Environment variables the Omni CLI reads, and how they interact with flags and the config file.
- [JSON requests and responses - Omni CLI](https://docs.omni.co/developers/cli/reference/json-requests-and-responses.md): The shape of request bodies, response payloads, and error output for Omni CLI commands.
- [Errors and exit codes - Omni CLI](https://docs.omni.co/developers/cli/reference/errors-and-exit-codes.md): How the Omni CLI signals success and failure to scripts, and where error detail goes.

### Agent skills

- [Omni agent skills](https://docs.omni.co/developers/agent-skills/index.md): Extend your IDE with Omni analytics skills for building models, running queries, managing content, and more.
- [Installing Omni agent skills](https://docs.omni.co/developers/agent-skills/install.md): Install Omni agent skills in Claude Code, Cursor, Cortex Code, and skills.sh-compatible agents.
- [Updating Omni agent skills](https://docs.omni.co/developers/agent-skills/update.md): Update Omni agent skills and troubleshoot cached or stale plugin versions.
- [Omni agent skills reference](https://docs.omni.co/developers/agent-skills/skills.md): Reference for all Omni agent skills, agents, and Cursor rules included in the plugin.

## OpenAPI Specs

- [openapi](/api/openapi.yaml)