Accessibility API

Build your own widget experience,
on the same API ours uses.

The INCLUXA widget API serves visitor profiles, presets, AI content transforms, usage events and feedback. Use it with your widget key to build a custom front end. Scanning, compliance reports and account management live in the INCLUXA portal.

Get a widget key View docs
Capabilities

What the API provides

In the portal

WCAG scanning, compliance and VPAT reports, analytics, team, keys and webhooks, while you are signed in.

AI content transforms

Simplify, summarize, translate, rephrase and suggest alt text (uses AI credits).

Presets

List the one-click presets and the tools each one turns on.

Visitor profiles

Read and save one visitor’s accessibility settings; saves need the short-lived profile token.

Usage events

Record which tools visitors turn on; reports are read in the portal.

Feedback and reports

Send visitor feedback and accessibility reports to your portal.

Authentication

Authentication

Widget requests carry your widget key in the X-Api-Key header. Widget keys are created in your INCLUXA portal.

curl https://api.incluxa.com/api/v1/presets \
  -H "X-Api-Key: inc_live_YOUR_KEY"
Widget keys are publishable: they sit in your page source, so they only reach the widget endpoints. Anything else answers 403. Each key sees only its own organization’s data.
Keys are stored as SHA-256 hashes — the raw key is shown once at creation.
Multiple keys per plan — rotate without downtime.
Rate limits apply per plan — see the table below.
Rate Limits

Rate limits

Limits are set per plan: a monthly API-call quota that resets each calendar month, and a per-minute request limit.

PlanAPI calls/monthRate limit
Solo10,000120 requests/minute
Starter50,000200 requests/minute
Pro250,000500 requests/minute
EnterpriseCustomCustom

When you exceed rate limits, the API returns HTTP 429. Your monthly quota is shown in the portal and returned in response headers.

Design

API design principles

RESTful JSON API

Standard HTTP methods (GET, POST, DELETE). All responses are JSON. Error responses include a code, message, and traceId.

Versioned endpoints

All endpoints are under /api/v1/. We will provide migration guides and deprecation notices before removing or changing endpoints.

Consistent error responses

HTTP 4xx and 5xx errors return a structured JSON body with error code, human-readable message, and a traceId for support requests.

No stack traces in responses

Error responses never include server stack traces or internal implementation details.

Idempotent where possible

Resource creation endpoints return the existing resource if called with the same identifier, reducing duplicate creation errors.