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 endpoints

Capabilities

What the API Provides

Visitor profiles

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

Presets

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

AI content transforms

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

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

In the portal

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

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 belongs to one organization and only sees that 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

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

Plan	API calls/month	Rate limit
Solo	10,000	120 requests/minute
Starter	50,000	200 requests/minute
Pro	250,000	500 requests/minute
Enterprise	Custom	Custom

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.

Start using the API

Create an account, create a widget key in the portal, and make your first request. Widget API access is included in all paid plans.

Get your widget key API docs