API Keys

RedRaven API keys are scoped to an organization. Public RedRaven API requests must include both the API key and the organization ID so RedRaven can validate the key against the right organization.

curl -sS \
  -H "X-API-Key: $REDRAVEN_API_KEY" \
  -H "X-Organization-Id: $REDRAVEN_ORGANIZATION_ID" \
  "$REDRAVEN_BASE_URL/api/v1/tests/$TEST_ID/results"

Create a Key

1. Open the RedRaven app.
2. Go to Organization Settings.
3. Open the Organization tab.
4. Select API Keys.
5. Click Add API Key, give it a name, and copy the value immediately.

Required Headers

Use the API host as REDRAVEN_BASE_URL:

export REDRAVEN_BASE_URL="https://api.redraven.fireraven.ai"

The public API routes live under /api/v1.

Rotate a Key

Create a replacement key, deploy it to your SDK clients or server-side integrations, then delete the old key after traffic has moved.

Delete a Key

Deleting a key cannot be undone. Delete keys that are no longer needed, keys owned by retired systems, and keys that may have been exposed.

Best Practices

• Use one key per service, integration, or deployment environment.
• Store keys in server-side secrets, not frontend bundles.
• Keep REDRAVEN_ORGANIZATION_ID with the same secret group as the key.
• Rotate keys after team or infrastructure ownership changes.
• Audit active keys before production launches.

Next Steps