> ## 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>

## Base URL

The API base URL is the same as the URL you use to login to Omni. For example, if you log in using `https://blobsrus.omniapp.co`, your base URL will be `https://blobsrus.omniapp.co/api`.

Only HTTPS calls are accepted.

<Tip>
  You can interactively browse and test API endpoints using the [API Explorer](/api/api-explorer), available at `/api-explorer` on your Omni instance.
</Tip>

## Available endpoints

| Entity                                                    | Resource                                                                                         | Version                                       |
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------- |
| [Who am I?](/api/who-am-i)                                | `/api/v1/whoami`                                                                                 | <Badge color="green">v1</Badge>               |
| [AI](/api/ai)                                             | `/api/v1/ai`                                                                                     | <Badge color="green" size="lg">v1</Badge>     |
| [AI credit controls](/api/ai-credit-controls)             | `/api/v1/ai/credit-controls`                                                                     | <Badge color="green" size="lg">v1</Badge>     |
| [AI evals](/api/ai-eval)                                  | `/api/v1/ai/eval`                                                                                | <Badge color="green">v1</Badge>               |
| [AI model suggestions](/api/ai-model-suggestions)         | `/api/v1/models/{modelId}/suggestions`<br />`/api/v1/models/{modelId}/suggestions/schedule`      | <Badge color="green">v1</Badge>               |
| [AI routines](/api/ai-routines)                           | `/api/v1/ai/routines`                                                                            | <Badge color="green">v1</Badge>               |
| [API tokens](/api/api-tokens)                             | `/api/v1/api-keys`                                                                               | <Badge color="green">v1</Badge>               |
| [Connections](/api/connections)                           | `/api/v1/connections`                                                                            | <Badge color="green">v1</Badge>               |
| [Connection environments](/api/connection-environments)   | `/api/v1/connection-environments`                                                                | <Badge color="green">v1</Badge>               |
| [Content migration](/api/content-migration)               | `/api/unstable/documents/:dashboardId/export`<br />`/api/unstable/documents/:dashboardId/import` | <Badge color="orange">beta</Badge>            |
| [Content validator](/api/content-validator)               | `/api/v1/models/:modelId/content-validator`                                                      | <Badge color="green">v1</Badge>               |
| [Dashboard downloads](/api/dashboard-downloads)           | `/api/v1/dashboards/:dashboardId/download`                                                       | <Badge color="green">v1</Badge>               |
| [Dashboard filters](/api/dashboard-filters)               | `/api/v1/dashboards/:dashboardId/filters`                                                        | <Badge color="green">v1</Badge>               |
| [dbt](/api/dbt)                                           | `/api/v1/connections/:connectionId/dbt`                                                          | <Badge color="green">v1</Badge>               |
| [dbt exposures](/api/dbt)                                 | `/api/v1/models/:modelId/dbt-exposures`                                                          | <Badge color="green">v1</Badge>               |
| [Documents](/api/documents)                               | `/api/v1/documents`                                                                              | <Badge color="orange">v1 (deprecated)</Badge> |
| [Documents v2](/api/documents-v2/create-document)         | `/api/v2/documents`                                                                              | <Badge color="green">v2</Badge>               |
| [Document favorites](/api/document-favorites)             | `/api/v1/documents/:documentId/favorite`<br />`/api/v1/documents/:identifier/favorites`          | <Badge color="green">v1</Badge>               |
| [Document labels](/api/document-labels)                   | `/api/v1/documents/:documentId/labels/:labelName`                                                | <Badge color="green">v1</Badge>               |
| [Document model](/api/documents)                          | `/api/unstable/documents/:documentId/update-model`                                               | <Badge color="orange">beta</Badge>            |
| [Document permissions](/api/document-permissions)         | `/api/v1/documents/:documentId/permissions`                                                      | <Badge color="green">v1</Badge>               |
| [Folders](/api/folders)                                   | `/api/v1/folders`                                                                                | <Badge color="green">v1</Badge>               |
| [Folder permissions](/api/folder-permissions)             | `/api/v1/folders/:folderId/permissions`                                                          | <Badge color="green">v1</Badge>               |
| [Jobs](/api/jobs)                                         | `/api/v1/jobs/:jobId/status`                                                                     | <Badge color="green">v1</Badge>               |
| [Labels](/api/labels)                                     | `/api/v1/labels`                                                                                 | <Badge color="green">v1</Badge>               |
| [Models](/api/models)                                     | `/api/v1/models`                                                                                 | <Badge color="green">v1</Badge>               |
| [Model branches](/api/model-branches)                     | `/api/v1/models/:modelId/branch/:branchName`                                                     | <Badge color="green">v1</Badge>               |
| [Model git configuration](/api/model-git-configuration)   | `/api/v1/models/:modelId/git`                                                                    | <Badge color="green">v1</Badge>               |
| [Model YAML](/api/models)                                 | `/api/v1/models/:modelId/yaml`                                                                   | <Badge color="green">v1</Badge>               |
| [Model schemas](/api/models)                              | `/api/v1/models/:modelId/schemas`                                                                | <Badge color="green">v1</Badge>               |
| [Model AI agent actions](/api/models)                     | `/api/v1/models/:modelId/ai-agent-actions`                                                       | <Badge color="green">v1</Badge>               |
| [Queries](/api/queries)                                   | `/api/v1/query/run`                                                                              | <Badge color="green">v1</Badge>               |
| [Schedules](/api/schedules)                               | `/api/v1/schedules`                                                                              | <Badge color="green">v1</Badge>               |
| [Schema refresh schedules](/api/schema-refresh-schedules) | `/api/v1/connections/:connectionId/schedules`                                                    | <Badge color="green">v1</Badge>               |
| [Topics](/api/topics)                                     | `/api/v1/models/:modelId/topics`                                                                 | <Badge color="green">v1</Badge>               |
| [Uploads](/api/uploads)                                   | `/api/v1/uploads`                                                                                | <Badge color="green">v1</Badge>               |
| [Users](/api/users)                                       | `/scim/v2/users`                                                                                 | <Badge color="blue">SCIM 2.0</Badge>          |
| [User attributes](/api/user-attributes)                   | `/api/v1/user-attributes`                                                                        | <Badge color="green">v1</Badge>               |
| [User groups](/api/user-groups)                           | `/scim/v2/groups`                                                                                | <Badge color="blue">SCIM 2.0</Badge>          |
| [User group model roles](/api/user-group-model-roles)     | `/api/v1/user-groups/{userGroupId}/model-roles`                                                  | <Badge color="green">v1</Badge>               |
| [User model roles](/api/user-model-roles)                 | `/api/v1/users/{userId}/model-roles`                                                             | <Badge color="green">v1</Badge>               |