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

# Authentication

> Learn how to authenticate with the ARGOS Omni API using your API key.

## API Key Authentication

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

```bash theme={null}
curl -X GET "http://client-omni-api.argosidentity.com/v1/projects/{projectId}" \
  -H "x-api-key: your-api-key-here"
```

## How to Get Your API Key

<Steps>
  <Step title="Log in to the Omni Dashboard">
    Access the Omni dashboard at your designated URL.
  </Step>

  <Step title="Navigate to Project Settings">
    Select your project and go to the settings page.
  </Step>

  <Step title="Copy Your API Key">
    Your API key is displayed in the project settings. Copy and store it securely.
  </Step>
</Steps>

<Warning>
  Never expose your API key in client-side code, public repositories, or logs. Store it securely using environment variables or a secret manager.
</Warning>

## Base URL

All API requests are made to the following base URL:

```
http://client-omni-api.argosidentity.com/v1
```

<Info>
  If you control network access with a firewall or proxy, allow outbound HTTP to **`client-omni-api.argosidentity.com`** (**port 80**) for Omni API calls. Allow **port 443** as well if you use HTTPS.
</Info>

## Request Headers

Every request must include:

| Header         | Value                                       | Required             |
| -------------- | ------------------------------------------- | -------------------- |
| `x-api-key`    | Your API key (UUID format)                  | Yes                  |
| `Content-Type` | `application/json` or `multipart/form-data` | Yes (for POST/PATCH) |

## Error Responses

If authentication fails, the API returns:

```json theme={null}
{
  "error": {
    "code": "UNAUTHORIZED",
    "status": 401,
    "message": "Invalid or missing API key"
  }
}
```
