Create Accessibility Test

Request

This endpoint allows users to submit an accessibility test for processing. It accepts a set of HTML content, processes it for accessibility issues, and returns a unique job ID for tracking the status of the test. The status of the job will display in the meta object, with a status of 'Processing'.

Security

basicAuth

Bodyapplication/jsonrequired

htmlstringrequired

The HTML content to be tested. Can be a raw HTML string or base64 encoded.

encodedboolean

Indicates whether the html content is base64 encoded (true) or raw (false).

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.mailgun.net/v1/inspect/accessibility \
  -H 'Content-Type: application/json' \
  -d '{
    "html": "string",
    "encoded": true
  }'

Responses

A 201 response

Bodyapplication/json

metaobject or null

itemsobject(github.com-mailgun-inspect-internal-accessibility-CreateAccessibilityResource)

Response

{
  "meta": {
    "created_at": "2025-05-28T05:30:00Z",
    "status": "Processing"
  },
  "items": {
    "id": "677ea3cdf1051e25e7dbfe73",
    "links": { … }
  }
}