REST API

The VertaaUX REST API enables programmatic access to UX auditing capabilities. Use it to integrate automated UX audits into your CI/CD pipelines, build custom dashboards, or create your own integrations.

Base URL

All API requests use the following base URL:

https://vertaaux.ai/api/v1

Authentication

Authenticate all requests using an API key in the X-API-Key header:

X-API-Key: vx_live_your_api_key_here

See Authentication for details on API key formats, sandbox mode, and security best practices.

Rate Limits

Rate limits are enforced on a daily basis and vary by subscription tier:

Tier	Audits per Day	Reset Time
Free	3	Midnight UTC
Pro	1,000	Midnight UTC
Agency	5,000	Midnight UTC
Enterprise	Unlimited	-

Rate Limit Headers

Every response includes rate limit information in the headers:

Header	Description
`X-RateLimit-Limit`	Maximum requests allowed in the current period
`X-RateLimit-Remaining`	Requests remaining in the current period
`X-RateLimit-Reset`	Unix timestamp when the rate limit resets
`Retry-After`	Seconds to wait before retrying (only on 429 responses)

Request Format

Content-Type: application/json for all request bodies
Accept: application/json for standard responses, application/x-ndjson for streaming

curl -X POST https://vertaaux.ai/api/v1/audit \
  -H "X-API-Key: vx_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Response Format

All responses return JSON with consistent structure:

Success response:

{
  "job_id": "clu1a2b3c4d5e6f7g8h9i0j1",
  "status": "queued",
  "created_at": "2024-01-15T10:30:00Z"
}

Error response:

{
  "error": "invalid_url",
  "message": "Invalid URL format. Must be a valid HTTP or HTTPS URL",
  "request_id": "req_abc123",
  "documentation_url": "/developer-docs/errors#invalid_url"
}