Authentication

The QuantSearch API uses API keys for authentication. API access is available on Pro and Enterprise plans.

Getting API Keys

1. Go to your Dashboard → API Keys
2. Click Create API Key
3. Give it a name (e.g., "Production", "Staging")
4. Copy the key immediately - it won't be shown again

Using API Keys

Include your API key in the Authorization header:

Authorization: Bearer qs_abc123def456...

Or use X-API-Key instead, if your client reserves theAuthorization header for something else. Both are equivalent:

X-API-Key: qs_abc123def456...

Example request:

curl https://www.quantsearch.ai/api/sites \
  -H "Authorization: Bearer qs_abc123def456..."

Key Format

Every key is qs_ followed by a random secret. There is nolive or test variant: a key belongs to the organisation that created it, in the environment it was created in, and production and staging are separate deployments with separate keys.

Key Permissions

API keys have full access to your organization's resources:

• Create, read, update, delete sites
• Start and manage crawl jobs
• Ingest and delete content
• Query search and chat APIs

Revoking Keys

If a key is compromised:

1. Go to Dashboard → API Keys
2. Find the key and click Revoke
3. Create a new key and update your applications

Revoked keys are rejected immediately.

Error Responses

Best Practices

• Use environment variables for API keys, never hardcode them
• Use separate keys for production and staging
• Rotate keys periodically
• Monitor API usage in your dashboard