Welcome,
| Name | Token | Created | Status | Actions |
|---|
To start a QA job via the API, make a POST request to the following endpoint with your API Token in the Authorization header.
POST /api/qa
Headers:
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Body:
{
"url": "https://your-target-url.com", // Max 150 chars
"testCase": "Your detailed test case description.", // Max 8000 chars
"spec": "(Optional) Your spec description.", // Max 8000 chars
"ragUrl": "(Optional) URL for RAG context." // Max 500 chars
}
To retrieve reports for a specific API Token, make a GET request to the following endpoint.
GET /api/qa/reports
Headers:
Authorization: Bearer YOUR_API_TOKEN
Example (cURL):
curl -H "Authorization: Bearer YOUR_API_TOKEN" /api/qa/reports
When a QA job is completed, a POST request with the following JSON payload will be sent to your configured webhook URLs. Your receiving server can parse this payload to handle subsequent actions.
Example Payload:
{
"jobId": 123,
"status": "completed",
"inputParams": {
"url": "https://example.com",
"testCase": "Verify login functionality",
"spec": "User should be able to log in.",
"ragUrl": null
},
"result": {
"report": "QA Report for example.com\nSummary\nTest Passed. The agent successfully..."
},
"completedAt": "2025-07-01T12:34:56.789Z"
}
Payload Fields:
jobId: The unique identifier for the QA job.status: The final status of the job. Since webhooks are sent upon completion, this will be either 'completed' or 'failed'.inputParams: The original parameters provided when the job was started.result: An object containing the output. On success, it has a `report` key. On failure, it may contain `error`, `logs`, and `errors`.completedAt: The ISO 8601 timestamp for when the job was completed.This will delete the token and all associated QA reports. This action cannot be undone. Please type to confirm.