Authentication

Secure your API requests with API keys.

API Key Format

API keys follow the format clk_live_.... Request your key via contact@canarycoders.es.

Authentication Methods

1. Bearer Token (recommended)

bash

curl -H "Authorization: Bearer clk_live_your_key_here" \
  https://canaryllm.canarycoders.es/api/llm/complete

2. X-API-Key Header

bash

curl -H "X-API-Key: clk_live_your_key_here" \
  https://canaryllm.canarycoders.es/api/llm/complete

3. Query Parameter

bash

curl "https://canaryllm.canarycoders.es/api/llm/complete?apiKey=clk_live_your_key_here"

Permissions

Permission	Description
`read`	Query models, providers, capabilities, key info
`write`	Submit completions, generate images/video, use queue

Rate Limits

Each API key has configurable rate limits:

Per minute — maximum requests per minute
Per day — maximum requests per day

When a rate limit is exceeded, the API returns a 429 status code with a Retry-After header.

Key Info

Retrieve information about your current API key:

bash

curl https://canaryllm.canarycoders.es/api/keys/info \
  -H "Authorization: Bearer clk_live_your_key_here"

json

{
  "success": true,
  "data": {
    "keyPrefix": "clk_live_abc...",
    "permissions": { "read": true, "write": true },
    "rateLimits": { "perMinute": 60, "perDay": 10000 },
    "createdAt": "2025-01-15T10:00:00Z"
  }
}