Skip to main content

Authentication

Programmatic access to the Redraven API uses an organization API key and the organization UUID. The same headers are used by the Python SDK.

Base URL

Use your Redraven deployment host only (no /api/v1 suffix in the host variable):

https://app.redraven.fireraven.ai

All routes on the following pages are under {base}/api/v1/....

Required headers

HeaderValue
X-API-KeyAPI key created in Redraven organization settings (e.g. rr_...)
X-Organization-IdUUID of the organization that owns the key

The API verifies that the key belongs to that organization.

Where to get credentials

  1. Open the Redraven app.
  2. Go to Organization settingsAPI Keys.
  3. Create or copy an API key and note your organization ID (UUID).
warning

API keys are secret. Do not commit them to source control or share them outside your organization.

curl template

Use this prefix on every request in Test outputs:

export REDRAVEN_BASE_URL="https://app.redraven.fireraven.ai"
export REDRAVEN_API_KEY="rr_..."
export REDRAVEN_ORGANIZATION_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

curl -sS \
-H "X-API-Key: ${REDRAVEN_API_KEY}" \
-H "X-Organization-Id: ${REDRAVEN_ORGANIZATION_ID}" \
"${REDRAVEN_BASE_URL}/api/v1/..."

JWT (web app only)

The Redraven web application uses Authorization: Bearer <access_token> (Supabase JWT). Integrations and the Python SDK should use API key + organization ID as above.