API Reference

Current endpoints, auth pattern, and account operations.

The current public API is exposed through Site Clinic's operations subdomain at /api/v1 and covers the subset of capabilities that are already contract-ready.

Base path
/api/v1/*

On the operations subdomain (app.siteclinic.io).

Keys
Live + test keys

Use live keys for production, test keys for integration work.

Account context
Slug required

Pass ?account= or x-siteclinic-account-slug header.

Endpoint families

Six families currently public

Site Clinic is one product system with multiple delivery layers. The public API only exposes capabilities that are currently ready for developer use. Internal-only capabilities stay internal.

ADA
/api/v1/ada/*

Queue audits, fetch results, and retrieve report artifacts for accessibility workflows.

Health
/api/v1/health/*

Run performance, security, and SEO checks for a target URL or property.

AI
/api/v1/ai/*

Retrieve current public AI-visibility signal snapshots, claim boundaries, and structured-content readiness exposed by the API today.

Keys
/api/v1/keys

Create, list, rotate, disable, and inspect API keys from your own developer account.

Usage
/api/v1/usage/*

Fetch current-period usage, included quota, and remaining capacity before you cross plan limits.

Migration
/api/v1/migration/*

Review migration-analysis jobs for database modernization and implementation planning.

Authentication

Bearer key + account slug

Send the API key as a Bearer token in the Authorization header. For account-scoped routes, also include the account slug either as a query parameter or as the x-siteclinic-account-slug header.

cURL
curl -X GET "https://app.siteclinic.io/api/v1/usage/stats?account=your-account-slug" \
  -H "Authorization: Bearer sc_live_your_api_key" \
  -H "x-siteclinic-account-slug: your-account-slug"
Response shape

data + meta envelopes

Successful responses return a top-level data object plus a meta block with request IDs, versioning, and usage accounting where supported.

Errors return a structured error object with a code, message, and request identifier for support follow-up. Detailed error-code documentation and key-management rules are forthcoming guides under developer docs.

Exercise these endpoints interactively from a browser session.