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.
Base URL
The API base URL is the same as the URL you use to login to Omni. For example, if you log in usinghttps://blobsrus.omniapp.co, your base URL will be https://blobsrus.omniapp.co/api.
Only HTTPS calls are accepted.
Available endpoints
| Entity | Resource | Version |
|---|---|---|
| Who am I? | /api/v1/whoami | v1 |
| AI | /api/v1/ai | v1 |
| AI credit controls | /api/v1/ai/credit-controls | v1 |
| AI evals | /api/v1/ai/eval | v1 |
| AI model suggestions | /api/v1/models/{modelId}/suggestions/api/v1/models/{modelId}/suggestions/schedule | v1 |
| AI routines | /api/v1/ai/routines | v1 |
| API tokens | /api/v1/api-keys | v1 |
| Connections | /api/v1/connections | v1 |
| Connection environments | /api/v1/connection-environments | v1 |
| Content migration | /api/unstable/documents/:dashboardId/export/api/unstable/documents/:dashboardId/import | beta |
| Content validator | /api/v1/models/:modelId/content-validator | v1 |
| Dashboard downloads | /api/v1/dashboards/:dashboardId/download | v1 |
| Dashboard filters | /api/v1/dashboards/:dashboardId/filters | v1 |
| dbt | /api/v1/connections/:connectionId/dbt | v1 |
| dbt exposures | /api/v1/models/:modelId/dbt-exposures | v1 |
| Documents | /api/v1/documents | v1 (deprecated) |
| Documents v2 | /api/v2/documents | v2 |
| Document favorites | /api/v1/documents/:documentId/favorite/api/v1/documents/:identifier/favorites | v1 |
| Document labels | /api/v1/documents/:documentId/labels/:labelName | v1 |
| Document model | /api/unstable/documents/:documentId/update-model | beta |
| Document permissions | /api/v1/documents/:documentId/permissions | v1 |
| Folders | /api/v1/folders | v1 |
| Folder permissions | /api/v1/folders/:folderId/permissions | v1 |
| Jobs | /api/v1/jobs/:jobId/status | v1 |
| Labels | /api/v1/labels | v1 |
| Models | /api/v1/models | v1 |
| Model branches | /api/v1/models/:modelId/branch/:branchName | v1 |
| Model git configuration | /api/v1/models/:modelId/git | v1 |
| Model YAML | /api/v1/models/:modelId/yaml | v1 |
| Model schemas | /api/v1/models/:modelId/schemas | v1 |
| Model AI agent actions | /api/v1/models/:modelId/ai-agent-actions | v1 |
| Queries | /api/v1/query/run | v1 |
| Schedules | /api/v1/schedules | v1 |
| Schema refresh schedules | /api/v1/connections/:connectionId/schedules | v1 |
| Topics | /api/v1/models/:modelId/topics | v1 |
| Uploads | /api/v1/uploads | v1 |
| Users | /scim/v2/users | SCIM 2.0 |
| User attributes | /api/v1/user-attributes | v1 |
| User groups | /scim/v2/groups | SCIM 2.0 |
| User group model roles | /api/v1/user-groups/{userGroupId}/model-roles | v1 |
| User model roles | /api/v1/users/{userId}/model-roles | v1 |