Documentation / API

API reference

Every capability is a /v1 REST endpoint.

Requests

Send a bearer token. Every POST takes an Idempotency-Key header.

curl -X POST https://api.helm.example/v1/page-audits \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: 7f3c-…"

Jobs

Sweeps, crawls, page audits, citation insights and reports run asynchronously. You receive 202 and a job id, then poll or receive a webhook.

Webhooks

Your CMS sends page.published. Helm registers the URL, takes a baseline and queues a URL audit and a post-publish re-audit.

Widget sessions

POST /v1/widget/sessions returns a page-scoped token that lasts five minutes.

Page audit checks

GET /v1/page-audits/checks returns the versioned check catalog used by the server-side scorer.

Last updated 26 October 2026