API Overview
RabbitQA provides a RESTful API for programmatic access.
Base URL
https://api.rabbitqa.com/v1
Authentication
All API requests require authentication via API key:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.rabbitqa.com/v1/projects
Response Format
All responses are JSON:
{
"success": true,
"data": { ... },
"meta": {
"page": 1,
"limit": 20,
"total": 100
}
}
Error Handling
Errors return appropriate HTTP status codes:
| Code | Meaning |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Server Error |
Pagination
List endpoints support pagination:
GET /v1/test-cases?page=1&limit=20