Base URLs
Revyl provides a unified REST API:
| Service | Base URL | Purpose |
|---|
| Backend API | https://backend.revyl.ai | Tests, builds, workflows, execution, device management |
All API endpoints are available through the Backend API at backend.revyl.ai.
Authentication
All API requests require a Bearer token in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://backend.revyl.ai/api/v1/builds/vars
Quick Reference
For end-to-end request examples, see API Quickstart.
Test Execution (Backend API)
| Method | Endpoint | Description |
|---|
| POST | /api/v1/execution/api/execute_test_id_async | Execute a test |
| GET | /api/v1/tests/get_test_execution_task?task_id={task_id} | Get test execution status |
| POST | /api/v1/execution/tests/status/cancel/{task_id} | Cancel running test |
Workflow Execution (Backend API)
| Method | Endpoint | Description |
|---|
| POST | /api/v1/execution/api/execute_workflow_id_async | Execute a workflow |
Workflow Status (Backend API)
| Method | Endpoint | Description |
|---|
| GET | /api/v1/workflows/status/status/{task_id} | Get workflow execution status |
| GET | /api/v1/workflows/history/{workflow_id} | Get workflow execution history |
Builds (Backend API)
| Method | Endpoint | Description |
|---|
| GET | /api/v1/builds/vars | List build variables |
| POST | /api/v1/builds/vars | Create build variable |
| GET | /api/v1/builds/vars/{id} | Get build variable |
| PATCH | /api/v1/builds/vars/{id} | Update build variable |
| DELETE | /api/v1/builds/vars/{id} | Delete build variable |
| POST | /api/v1/builds/vars/{id}/versions/stream-upload | Stream upload build |
| POST | /api/v1/builds/vars/{id}/versions/from-url | Create from remote URL |
| GET | /api/v1/builds/vars/{id}/versions | List build versions |
| GET | /api/v1/builds/versions/{version_id} | Get build version |
| PATCH | /api/v1/builds/versions/{version_id} | Update build version |
| DELETE | /api/v1/builds/versions/{version_id} | Delete build version |
YAML Operations (Backend API)
| Method | Endpoint | Description |
|---|
| POST | /api/v1/yaml/from-yaml | Create test from YAML |
| POST | /api/v1/yaml/from-blocks | Create test from blocks |
| POST | /api/v1/yaml/validate-yaml | Validate YAML |
| POST | /api/v1/yaml/conversion/blocks-to-yaml | Convert blocks to YAML |
| POST | /api/v1/yaml/conversion/yaml-to-blocks | Convert YAML to blocks |
Monitoring (Backend API)
| Method | Endpoint | Description |
|---|
| GET | /api/v1/monitor/stream/unified | Stream real-time updates (SSE) |
Success Response
{
"task_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "queued",
"message": "Operation successful"
}
Error Response
{
"detail": "Error message describing what went wrong"
}
Status Codes
| Code | Description |
|---|
| 200 | Success |
| 400 | Bad request (invalid parameters) |
| 401 | Unauthorized (invalid API key) |
| 403 | Forbidden (insufficient permissions) |
| 404 | Resource not found |
| 409 | Conflict (duplicate resource) |
| 422 | Unprocessable entity (validation failed) |
| 500 | Server error |
| 502 | Bad gateway (upstream service error) |
| 503 | Service unavailable |
OpenAPI Specifications
Full OpenAPI specifications are available at:
- Backend API:
https://backend.revyl.ai/openapi.json
These specifications power the interactive playground in this documentation.
