> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Omni REST APIs

> Programmatically interact with your Omni instance with Omni's REST APIs.

<Note>
  **Prefer to work from your terminal or IDE?** Omni's [CLI](/developers/cli) and [agent skills](/developers/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](https://github.com/exploreomni/cli) and the [agent skills repo](https://github.com/exploreomni/omni-agent-skills).
</Note>

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

<Columns cols={4}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    Authenticate your requests with an API token.
  </Card>

  <Card title="Base URL" icon="link" href="/api/base-url">
    Find the base URL for requests to your Omni instance.
  </Card>

  <Card title="Versioning" icon="arrow-rotate-right" href="/api/versioning">
    See how endpoints are versioned and their current status.
  </Card>

  <Card title="Rate limits" icon="circle-stop" href="/api/rate-limits">
    Understand and handle throttling behavior.
  </Card>

  <Card title="Errors and retries" icon="triangle-exclamation" href="/api/errors">
    Handle error responses, including scheduled maintenance.
  </Card>
</Columns>

## 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](/api/api-explorer), available at `/api-explorer` on your Omni instance.

To get started, get your Omni [base URL](/api/base-url) and generate an [API key](/api/authentication).

<Warning>
  **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.
</Warning>

## Guides

Task-based walkthroughs for common API workflows. See the [Guides section](/guides/?tags=api) for all API guides.

<Columns cols={3}>
  <Card title="Run document queries" href="/guides/api/run-document-queries">
    Programmatically run document queries
  </Card>

  <Card title="Port SQL into a workbook" href="/guides/api/port-sql-queries-omni-api">
    Build tabs and tiles with a bash script
  </Card>

  <Card title="Bulk update model YAML" href="/guides/api/bulk-update-model-yaml">
    Batch YAML updates into a single Git sync
  </Card>

  <Card title="Set up connection environments" href="/guides/api/connection-environments">
    Configure dev and prod connection environments
  </Card>

  <Card title="Build a data lineage integration" href="/guides/api/data-lineage-integration">
    Build OpenMetadata or DataHub integrations
  </Card>

  <Card title="All API guides" href="/guides/?tags=api">
    See all API guides
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.