Skip to content

Authentication

All API requests (except the health check) require authentication via an API key.

Getting Your API Key

Contact the Icana.AI team to receive your API key:

  • Email: support@icana.ai
  • Website: icana.ai

Warning

Your API key grants full access to your account. Keep it secret — do not commit it to version control or share it in client-side code.

Using Your API Key

Include your API key in the X-API-Key header of every request:

X-API-Key: your-api-key

Example

curl https://api.icana.ai/queue/status \
  -H "X-API-Key: your-api-key"

Verifying Your Key

You can verify your API key is working by calling the queue status endpoint:

curl -w "\n%{http_code}" https://api.icana.ai/queue/status \
  -H "X-API-Key: your-api-key"

A 200 response means your key is valid. A 401 response means the key is invalid or missing.

Error Responses

If authentication fails, the API returns a 401 Unauthorized response.

See Errors for the full list of error codes.