Skip to main content

API Key Authentication

All Omni API requests require authentication via the x-api-key header.

How to Get Your API Key

1

Log in to the Omni Dashboard

Access the Omni dashboard at your designated URL.
2

Navigate to Project Settings

Select your project and go to the settings page.
3

Copy Your API Key

Your API key is displayed in the project settings. Copy and store it securely.
Never expose your API key in client-side code, public repositories, or logs. Store it securely using environment variables or a secret manager.

Base URL

All API requests are made to the following base URL:
If you control network access with a firewall or proxy, allow outbound HTTPS to client-omni-api.argosidentity.com (port 443) for Omni API calls.

Request Headers

Every request must include:

Error Responses

If authentication fails, the API returns: