Blyxo API Documentation

The Blyxo REST API lets you start and manage website scans from your own code. It supports accessibility testing against WCAG 2.1 criteria, SEO analysis, performance monitoring, and security scanning. All requests are authenticated with an API key sent in the X-API-Key header.

The base URL for all endpoints is https://api.blyxo.app/api/v1. API access is available on Professional ($99/month) and Enterprise plans. Responses use JSON format and follow OpenAPI 3.0 conventions.

Available Endpoints

  • GET /sites — List all registered sites for your account
  • POST /sites/{siteId}/accessibility/scans — Trigger a WCAG accessibility scan
  • POST /sites/{siteId}/seo/scans — Trigger an SEO analysis scan
  • POST /sites/{siteId}/performance/scans — Trigger a performance scan
  • POST /sites/{siteId}/security/scans — Trigger a security scan
  • POST /sites/{siteId}/quality/scans — Trigger a content quality scan
  • GET /scans/{scanId} — Check scan status and retrieve results
  • GET /scans/{scanId}/report — Download a detailed scan report

Interactive API Reference

Explore endpoints, test requests, and view response schemas below

← Back to Developer Portal

Loading API documentation...

Frequently Asked Questions

How do I authenticate with the Blyxo API?

Add your API key to the X-API-Key header on every request. You can create API keys in your Blyxo dashboard under Settings. Keys use the format key_xxx and must be kept secret.

What endpoints does the Blyxo API provide?

The API lets you list your sites, start scans for accessibility, SEO, performance, security, and content quality, check scan status, and download reports. Each scan type has its own POST endpoint under /sites/{siteId}/.

How do I integrate Blyxo into my CI/CD pipeline?

Call the API to start a scan after each deploy. Blyxo has guides for GitHub Actions, GitLab CI, Jenkins, and Bitbucket Pipelines at blyxo.app/developers/guides. One POST request starts a scan, and you can poll for results or get them via webhook.

What response format does the API return?

All API responses are returned in JSON format. Successful responses include a data field with the result and a meta field with request metadata. Error responses include an error object with a code, message, and details array.

Are there rate limits on the Blyxo API?

Yes, rate limits depend on your plan tier. Professional plans allow up to 2 scans per day with 100 pages per scan. Enterprise plans have unlimited scans and pages. API key usage is tracked in your dashboard.

About the Author

This documentation is maintained by the Blyxo engineering team — accessibility engineers and web quality experts who build and maintain the Blyxo platform. The API is used by development teams to automate Section 508 and WCAG compliance testing in CI/CD pipelines across healthcare, finance, education, and government.