API Overview
Introduction to the Ayorax REST API — authentication, base URL, and response format.
The Ayorax REST API lets you read and write data programmatically — create leads, trigger workflows, fetch analytics, and integrate Ayorax into your own systems.
Base URL
Authentication
All API requests require a Bearer token in the Authorization header.
Response format
HTTP status codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request — validation error |
| 401 | Unauthorized — invalid or missing API key |
| 403 | Forbidden — insufficient permissions |
| 404 | Not found |
| 429 | Rate limit exceeded |
| 500 | Internal server error |
Key endpoints
- GET /v1/leads — list and filter leads
- POST /v1/leads — create a lead
- POST /v1/leads/:id/score — trigger AI scoring
- GET /v1/workflows — list workflows
- POST /v1/workflows/:id/run — trigger a workflow
- POST /v1/webhooks — register a webhook
Related articles
API Authentication
Generate API keys, manage scopes, and authenticate your requests securely.
Rate Limits
API rate limit tiers, headers, and how to handle 429 responses gracefully.
Webhook Events
Subscribe to real-time events from Ayorax and receive HTTP POST payloads to your endpoint.
SDKs & Libraries
Official and community SDKs for integrating Ayorax into your application.