API Authentication

API Keys

Your API keys are used to authenticate requests to the Intellectua REST API. Keep them secure and never share them publicly.

Ready to secure your app?

Go to your clinical dashboard to generate your production API key and start building.

Generate API Key

1Creating your API Key

API Keys are managed in the Settings section of your Intellectua Dashboard.

  • Click Settings in the sidebar.
  • Navigate to the API & Webhooks tab.
  • Click Generate New Key.
  • Give your key a descriptive name (e.g., 'Downtown Scanner Integration').
  • Copy and save your raw key immediately. For security, we only show it once.

2Using your API Key

All API requests must include your API key in the x-api-key HTTP header.

Example cURL Request
bash
curl -X GET "https://api.intellectua.ai/v1/documents" \
     -H "x-api-key: intel_live_YOUR_KEY_HERE" \
     -H "Content-Type: application/json"

Key Rotation

If you suspect your API key has been compromised, you should revoke and rotate it immediately from the dashboard. Once revoked, subsequent calls with that key will fail instantly.

Secure Storage

Keys are hashed using SHA-256 before database insertion. Intellectua never stores plain-text keys in its persistence layer.

Security Warning

Never commit your API keys to version control (like Git). Always use environment variables to store sensitive keys in your application. For storing third-party secrets, refer to our API Secrets guide.