Authentication

​

Creating API Keys

1. Log in to Mission Control.
2. Navigate to Settings → API Keys.
3. Click Create API Key.
4. Give the key a descriptive name (e.g., production-backend, ci-pipeline).
5. Copy the key immediately.

​

Using API Keys

curl https://server.avala.ai/api/v1/agents \
  -H "X-Avala-Api-Key: avala_sk_your_api_key"

​

Managing API Keys

• View active keys — See all keys, their names, and creation dates.
• Revoke a key — Immediately invalidate a key. Revoked keys cannot be restored.
• Regenerate a key — Create a new key to replace an existing one.

​

Key Expiration

​

Best Practices

• Use environment variables — Never hard-code API keys in source code. Load them from environment variables or a secrets manager.
  Copy

  Ask AI

  export AVALA_API_KEY="avala_sk_your_api_key"
  
• Rotate keys regularly — Revoke and regenerate keys on a recurring schedule, especially after team changes.
• Use separate keys per environment — Create distinct keys for development, staging, and production so you can revoke one without affecting others.
• Restrict access — Only share keys with the people and services that need them. Audit key usage periodically.

​

Error Responses

{
  "detail": "Invalid API key."
}

{
  "detail": "API key has expired."
}

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

​

Next Steps