Skip to main content
The Ravenna API allows you to programmatically interact with your Ravenna workspace. Use it to create tickets, manage queues, sync data, and automate workflows.

​
Authentication

All API requests require authentication using an API key. Include your API key in the x-ravenna-api-token header: 
curl --request GET \
  --url https://core.ravenna.ai/api/queues \
  --header 'x-ravenna-api-token: <api-key>'

​
Getting your API key

  1. Navigate to Settings in your Ravenna workspace
  2. Select API Keys from the sidebar
  3. Click Create API Key
  4. Copy your key—you can view it again at any time from the settings page
Keep your API key secure. Never expose it in client-side code or public repositories.

​
Revoking an API key

To revoke an API key, go to Settings > API Keys and delete the key you want to revoke.

​
Base URL

All API requests should be made to: 
https://core.api.ravenna.ai

​
Rate limits

The API enforces rate limits to ensure fair usage. If you exceed the limit, you’ll receive a 429 Too Many Requests response. Wait before retrying.

​
Response format

All responses are returned in JSON format. Successful responses include the requested data, while errors include a message describing the issue: 
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key provided"
  }
}

​
Next steps

Explore the API endpoints in the sidebar to see available operations.