Introduction

Getting started with the Clarifeye REST API

Base URL

The Clarifeye API is available at:

Region	Base URL
EU	https://eu.app.clarifeye.ai/api/v1
US	https://us.app.clarifeye.ai/api/v1

For dedicated environments, use your own custom URL provided by Clarifeye.

Authentication

All API requests require authentication. Include your API token in the Authorization header using either format:

Authorization: Bearer YOUR_API_TOKEN

You can retrieve your api key in the Account page of the application.

Making Requests

Python

import requests

BASE_URL = "https://eu.app.clarifeye.ai/api/v1"
PROJECT_ID = "your-project-id"

headers = {
    "Authorization": "Bearer YOUR_API_TOKEN"
}

# List project users
response = requests.get(
    f"{BASE_URL}/projects/{PROJECT_ID}/users/",
    headers=headers
)
print(response.json())

Response Format

All responses are returned in JSON format. Successful list responses are paginated:

{
  "count": 42,
  "next": "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/users/?offset=100",
  "previous": null,
  "results": [...]
}

Error responses include an error message:

{
  "error": "Authentication credentials were not provided."
}