Skip to main content

API Overview

This is a space that is continually developing, watch this space and reach out to your Omni support if you have any pressing use cases.

Base URL​

The API base URL is the same as the URL you use to login to Omni. So if you login at https://myorg.omniapp.co, then your API base URL is https://myorg.omniapp.co/api, and an example API endpoint is https://myorg.omniapp.co/api/v0/model/\{modelId\}/refresh. Only HTTPS calls are accepted.

Authentication​

The Omni API uses API keys to authenticate requests. You can manage your API keys in the Settings > API Keys. If you don't have access to API keys, contact support. Each API request is expected to have an Authentication header header with the API key as a Bearer token, ie Authentication: Bearer <API key>.

Examples​

curl -X POST -H "Authentication: Bearer myapikey" https://myorg.omniapp.co/api/v0/model/10d0e6d8-3a19-4f85-93d9-1e87dc701413/refresh