DEVELOPER API v1

The design linter for your deployment pipeline.

Automate interface craft verification. Ingest live URLs or staging previews in CI/CD, calculate heuristic slop scores, and receive machine-readable Tailwind and copy patches before pushing to production.

Interactive Playground ↓
AUTHENTICATION

Bearer Token

Pass your key in standard Authorization: Bearer sk_live_... or X-API-Key request headers.

BASE ENDPOINT

POST /api/v1/audit

High-concurrency global endpoint with deterministic computed-style extraction plus a model reasoning pass.

CI/CD GATING

Automated PR Checks

Pass "failOnSlop": true to return HTTP 422 whenever a preview URL exceeds your configured slop threshold.

curl -X POST https://slopcheckr.com/api/v1/audit \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "maxSlopScore": 40,
    "failOnSlop": false
  }'
INTERACTIVE REST CONSOLE

Test the SlopCheckr v1 API live.

POST /api/v1/audit

API Schema & Parameter Reference

REQUEST BODY PARAMETERS
urlstring · required

The public domain or staging URL to audit (e.g. https://mycompany.com).

maxSlopScorenumber · optional

A score threshold from 0 to 100. If set, ciValidation.passed is computed against this ceiling.

failOnSlopboolean · optional (default: false)

When true, returns HTTP status 422 if the website's slop score exceeds maxSlopScore, immediately failing CI pipelines.

HTTP RESPONSE CODES
200 OKAudit executed successfully. Structured findings and Tailwind patches returned.
401 UNAUTHORIZEDMissing, invalid, or revoked secret API key.
402 PAYMENT REQUIREDCredit quota exhausted. Upgrade to Pro for unlimited API requests.
422 CI FAILEDReturned when failOnSlop: true and the interface exceeds the configured slop threshold.
502 BAD GATEWAYTarget website timed out or was unreachable by the headless Chromium crawler.
AUTOMATED BILLING & WEBHOOKS

Paddle-Powered Quotas & Developer API Packs

● Live Webhook Engine Active

All API usage, CI/CD audits, and membership upgrades are processed through secure Paddle Billing. Free accounts receive 1 initial audit credit upon email verification. When running automated pipelines in GitHub Actions, subscribe to Unlimited Pro ($15/mo or $9/mo annual) or buy Developer API bulk packs (+50 audits for $99) directly through your Account Hub or via Paddle checkout.

PADDLE WEBHOOK ROUTE/api/paddle/webhook
CHECKOUT ENDPOINT/api/paddle/checkout
CUSTOMER PORTAL/api/paddle/portal