Skip to main content
Use the Ravenna API to programmatically create tickets, manage queues, sync data, and automate workflows in your workspace. All requests use REST principles with JSON responses and require API key authentication.

​
Getting started

Base URL: https://core.ravenna.ai/api Authentication: Include your API key in the x-ravenna-api-token header with every request. Example request: 
curl --request GET \
  --url https://core.ravenna.ai/api/queues \
  --header 'x-ravenna-api-token: <api-key>'

​
Authentication

​
Create an 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 and store it securely
You can view your API keys at any time from the settings page.
Keep your API key secure. Never expose it in client-side code or public repositories.

​
Use your API key

Include your API key in the x-ravenna-api-token header with every request: 
curl --request GET \
  --url https://core.ravenna.ai/api/queues \
  --header 'x-ravenna-api-token: your-api-key-here'

​
Revoke an API key

To revoke an API key:
  1. Go to Settings > API Keys
  2. Find the key you want to revoke
  3. Click the delete button
Revoked keys stop working immediately.

​
Making requests

​
Response format

All responses return JSON. Successful responses include the requested data: 
{
  "id": "123",
  "name": "Support Queue",
  "status": "active"
}
Error responses include a code and message: 
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key provided"
  }
}

​
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 your request.

​
Common error codes

  • 401 Unauthorized: Invalid or missing API key
  • 403 Forbidden: Valid API key but insufficient permissions
  • 404 Not Found: Resource doesn’t exist
  • 429 Too Many Requests: Rate limit exceeded
  • 500 Internal Server Error: Server error, contact support if persistent