Back to Documentation
DocsScans Endpoint
3 min read
Scans Endpoint
The Scans API allows you to programmatically trigger new accessibility audits and retrieve their results.
POST
/api/v1/scans
Triggers a new asynchronous accessibility scan against a specified URL. Returns a job ID that you can use to poll for the result.
cURL Example
curl -X POST https://api.aulys.com/v1/scans \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/checkout",
"wcag_version": "2.2",
"wcag_level": "AA"
}'GET
/api/v1/scans/:id
Retrieves the status and result of a previously triggered scan. If the scan is still running, the `status` field will be `processing`. Once finished, it will change to `completed` and the result payload will be populated.
Response Object (Completed)
{
"id": "scan_123456789",
"status": "completed",
"score": 85,
"violations": {
"critical": 2,
"warning": 5,
"info": 12
},
"url": "https://example.com/checkout",
"created_at": "2024-01-01T12:00:00Z",
"completed_at": "2024-01-01T12:00:25Z"
}