Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

The Clarifeye client uses token-based authentication. You’ll need both a base URL for your Clarifeye instance and an API token.

​
Getting Your Credentials

  1. Base URL: This is the URL of your Clarifeye instance (e.g., https://your-company.clarifeye.ai)
  2. API Token: Generate this from your Clarifeye dashboard under Settings > API Tokens

​
Setting Up Authentication

​
Direct Instantiation

from crf_api_client.client import CRFAPIClient

client = CRFAPIClient(
    base_url="https://your-instance.clarifeye.ai",
    token="your-api-token"
)

​
Environment Variables

For security, it’s recommended to use environment variables: 
export CLARIFEYE_BASE_URL="https://your-instance.clarifeye.ai"
export CLARIFEYE_TOKEN="your-api-token"

import os
from crf_api_client.client import CRFAPIClient

client = CRFAPIClient(
    base_url=os.getenv("CLARIFEYE_BASE_URL"),
    token=os.getenv("CLARIFEYE_TOKEN")
)

​
Testing Authentication

Test your authentication setup: 
try:
    warehouses = client.list_warehouses()
    print("Authentication successful!")
except Exception as e:
    print(f"Authentication failed: {e}")