Skip to main content
Prefer to work from your terminal or IDE? Omni’s CLI and agent skills wrap these REST APIs so you can query data, manage models, and automate workflows without hand-writing HTTP calls. Both are open source — browse the CLI repo and the agent skills repo.
Omni’s REST APIs let you manage and automate your Omni instance programmatically, including configuring database connections, building and managing semantic models, organizing documents, dashboards, and folders, running queries, provisioning users and groups, scheduling deliveries, and integrating Omni’s AI.

​
Overview

Authentication

Authenticate your requests with an API token.

Base URL

Find the base URL for requests to your Omni instance.

Versioning

See how endpoints are versioned and their current status.

Rate limits

Understand and handle throttling behavior.

​
Endpoints

Looking for endpoint references? Use the navigation on the left side of the page to navigate and view reference documentation. Endpoints are grouped by resource type. For example, the AI APIs section contains references for endpoints related to the Omni Agent and other AI features.

​
Interacting with APIs

The Omni API docs include a secure, interactive environment that you can use to test and explore API endpoints using your Omni data. You can also browse and test API endpoints using the API Explorer, available at /api-explorer on your Omni instance. To get started, get your Omni base URL and generate an API key.
Heads up! Authenticated requests sent from the docs API playground or API Explorer will interact with real data in your Omni organization. Use caution when experimenting with the APIs. You can also set up dedicated test data before sending requests.

​
Guides

Task-based walkthroughs for common API workflows. See the Guides section for all API guides.

Run document queries

Programmatically run document queries

Port SQL into a workbook

Build tabs and tiles with a bash script

Bulk update model YAML

Batch YAML updates into a single Git sync

Set up connection environments

Configure dev and prod connection environments

Build a data lineage integration

Build OpenMetadata or DataHub integrations

All API guides

See all API guides