Authentication

All API requests require authentication using an API key.

Getting an API key

1. Log in to your oqui dashboard
2. Go to Settings > Developer > API Keys
3. Click Create API Key
4. Give your key a descriptive name
5. Copy the key immediately (it won't be shown again)

API keys are prefixed with ckiq_live_ for production or ckiq_test_ for test environments.

Using your API key

Include your API key in the Authorization header of every request:

Authorization: Bearer ckiq_live_your_api_key_here

Example request

curl -X POST https://oqui.io/api/v1/assess \
  -H "Authorization: Bearer ckiq_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{ ... }'

API key security

Best practices:

• Never commit API keys to version control
• Use environment variables to store keys
• Rotate keys periodically
• Use separate keys for development and production
• Monitor API usage for anomalies

If a key is compromised:

1. Immediately revoke the key in your dashboard
2. Create a new key
3. Update your applications
4. Review API logs for unauthorized usage

Rate limiting

Each API key has a rate limit of 60 requests per minute by default.

When you exceed the limit, you'll receive a 429 response:

{
  "error": "Rate limit exceeded",
  "retry_after": 60,
  "limit": 60
}

Wait for retry_after seconds before retrying.

Credits

API requests consume credits from your account balance:

• 1 credit per successful assessment
• Failed assessments (processing errors) don't consume credits
• Check your balance in the dashboard or via API

If you have insufficient credits, you'll receive a 402 response:

{
  "error": "Insufficient credits",
  "credits_required": 1,
  "credits_available": 0
}

Managing API keys

In your dashboard, you can:

• View all keys - See name, prefix, and creation date
• Revoke keys - Immediately disable a key
• Create new keys - Generate additional keys
• View usage - See request counts and patterns

Each team account can have multiple API keys for different purposes (e.g., production, staging, different applications).