API Reference

Pro plan required

The external API is available on the Pro plan.

navable provides an external API that lets you integrate accessibility audits and URL management into your own workflows — for example, triggering an audit from a CI/CD pipeline after each deployment.

Authentication

All API requests require an API key passed in the x-api-key header. You can create and manage API keys from Settings → API Keys in the dashboard. See API Keys for details.

x-api-key: your-api-key

Base URL

All endpoints are relative to your navable dashboard URL:

https://app.navable.io/api/v1

Endpoints

Trigger an audit

Start an accessibility audit for a URL collection.

POST /api/v1/audit/{urlCollectionId}

Request body (optional):

{
  "urls": ["https://example.com/page1", "https://example.com/page2"],
  "wcagStandardDto": 0
}

• urls — Optional list of URLs to audit. If omitted, all URLs in the collection are audited. URLs must belong to the collection's domain.
• wcagStandardDto — Optional WCAG standard to use (0 = WCAG 2.1 AA, 1 = WCAG 2.1 AAA, 2 = WCAG 2.2 AA, 3 = WCAG 2.2 AAA). Defaults to WCAG 2.1 AA.

Response (201 Created):

{
  "scheduledAuditJobId": "a1b2c3d4-..."
}

Add URLs to a collection

Add new page URLs to an existing URL collection.

POST /api/v1/urls/{urlCollectionId}

Request body:

{
  "urls": ["https://example.com/new-page1", "https://example.com/new-page2"]
}

• urls — Required list of URLs to add. URLs must belong to the collection's domain. Duplicates are automatically skipped.

Response (200 OK):

{
  "added": 2,
  "duplicatesSkipped": 0
}

Rate limiting

API requests are rate-limited to 30 requests per minute per organization. If you exceed this limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait before retrying.

Error responses

Status	Meaning
400	Invalid request (malformed URLs or missing data)
401	Missing or invalid API key
403	Audit budget exceeded for your plan
404	URL collection not found
429	Rate limit exceeded — check the Retry-After header

Finding your URL collection ID

You can find your URL collection ID in Settings → API Keys.