Accessibility Checker

Ensure your webpage complies with WCAG accessibility standards and best practices.

POST

1https://api-buildflow.modal.run/api/accessibility-checker

Request Parameters

url: string (required) – The URL of the webpage to check for accessibility.

Request Schema

1{
2  "url": "string"
3}

Success Response

1{
2  "issues": {
3    "type": "string",
4    "title": "string",
5    "description": "string",
6    "impact": "string",
7    "wcagCriteria": "string[]"
8  },
9  "groupedIssues": "Record<string, any[]>",
10  "score": "number",
11  "summary": {
12    "total": "number",
13    "critical": "number",
14    "serious": "number",
15    "moderate": "number",
16    "minor": "number"
17  },
18  "colorContrast": {
19    "compliant": "boolean",
20    "nonCompliantElements": "string[]"
21  },
22  "keyboardNavigation": {
23    "accessible": "boolean",
24    "focusVisible": "boolean",
25    "inaccessibleElements": "string[]"
26  },
27  "ariaRoles": {
28    "valid": "boolean",
29    "missingRoles": "string[]",
30    "incorrectRoles": "string[]"
31  }
32}

Error Response

1{
2  "error": "string"
3}

Example Usage

1
2curl -X POST 'https://api-buildflow.modal.run/api/accessibility-checker' \
3-H 'Content-Type: application/json' \
4-H 'x-api-key: your-api-key' \
5-d '{
6  "url": "example-url"
7}'
8