Documentation

CI / API scans

Pro and Enterprise plans can create API keys in Settings and scan files from any CI system without installing the GitHub App on that pipeline.

1. Create an API key

Dashboard → Settings → CI / API keys → Create key. Copy the secret once (a11y_…).

Open settings

2. POST /api/v1/scan

curl -X POST "$API_URL/api/v1/scan" \
  -H "Authorization: Bearer $MEERKAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "repository": "acme/web",
    "ref": "abc123",
    "files": [
      {
        "path": "src/Button.tsx",
        "content": "<button></button>"
      }
    ]
  }'

Max 50 files per request, 200KB per file
Scannable extensions: html, jsx, tsx, vue, svelte
Counts against monthly scan limits
Returns passed, summary, and issues

3. Example CI exit code

# fail the job when critical issues are present
if [ "$(jq -r .passed response.json)" != "true" ]; then
  exit 1
fi

Need help? [email protected]