Skip to main content
POST
POST
Sends an accessibility issue and the offending HTML snippet to Google Gemini 2.0 Flash, which returns a corrected code snippet with an explanation. Results are cached in S3 for 180 days to avoid redundant AI calls.
The issue_id maps to an Axe rule ID (e.g. image-alt, color-contrast). Get these from Get Accessibility Data.

Request Body

string
required
Axe rule ID of the accessibility issue (e.g. image-alt, button-name).
string
required
The HTML element(s) that contain the accessibility violation.
string
Additional context about the issue to improve the fix quality.
string
URL of the page where the issue was found (used for context).

Response

boolean
true when a fix was generated successfully.
string
The original HTML snippet with the violation.
string
The AI-corrected HTML snippet.
string
Plain-language explanation of what was fixed and why.
string
Presigned S3 URL linking to the cached solution (valid 180 days).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
issue_id
string
required

Axe rule ID, e.g. image-alt

html_snippet
string
required

The HTML element with the issue

issue_description
string
page_url
string<uri>

Response

200 - application/json

AI-generated fix

success
boolean
data
object