Developers
Read public agent reports. No API key required.
Site crawl
POST /api/site-audit
{"url":"https://www.example.com","maxPages":25}Public, same-origin HTML sample. Up to 25 pages, 3 sitemap files and 40 seconds. Includes coverage, findings, link sources and explicit exclusions. Robots permission must be established before crawling. POST only; failures use problem JSON. Search Console and citation imports in the SEO page stay in the browser.
SEO workspaceReport API
GET /api/v1/agentic/report?url=lightmark.app
JSON by default. Request text/markdown for Markdown.
OpenAPI specificationCLI
npx --yes --package=https://www.lightmark.app/downloads/lightmark-agentic-0.1.0.tgz lightmark lightmark.app --json
Install the standalone CLI directly. Use --read-only to prevent new scans. npm registry publication is pending.
MCP
https://www.lightmark.app/mcpStreamable HTTP. Read reports and evidence. Compatible MCP Apps hosts display an interactive scorecard.
Reviewed repository fixes
node scripts/repository-fix.js --help
Run from a Lightmark source checkout. Apply an approved patch in an isolated Git worktree, run explicit checks, verify a public deployment marker and rescan, or create a tested revert. Deployment is a separate operator step.
Workflow instructionsErrors and limits
400: invalid request. 404: scan first. 429: honor Retry-After. 503: retry later. Report reads: 120 requests per IP per minute, advertised in RateLimit headers. Ora scan quotas are separate.
Full documentationAgent skill
npx skills add adamtpang/lightmark.app --skill lightmarkVersioning and deprecation
The report API uses /api/v1. Additive response fields may appear without a version change; clients should ignore unknown fields. Breaking changes require a new major URL version. Deprecations will be announced here at least 90 days before removal, with Deprecation and Sunset headers on affected endpoints. No v1 endpoints are currently scheduled for removal.