Docs for agents

This page is for AI agents and for the people configuring them. Everything on this site, and the API it documents, is reachable in plain-text and machine-readable forms — no HTML scraping required.

Markdown twins

Every page on this site has a markdown twin. Append .md to any page URL:


https://docs.regsn.app/api/quickstart      → the HTML page
https://docs.regsn.app/api/quickstart.md   → the same page as markdown

The site root is https://docs.regsn.app/index.md. Twins are regenerated on every deploy from the same sources as the HTML, so they never lag it. The Copy page menu on each page copies or links the twin directly.

llms.txt

Two index files, following the llms.txt convention :

File	Contents
`/llms.txt`	The documentation index — every page, one line each, linked to its markdown twin
`/llms-full.txt`	The entire documentation set concatenated in navigation order, with per-page source URLs

Point an agent at llms.txt when it should choose what to read; hand it llms-full.txt when it should read everything (roughly a hundred thousand tokens — check your context budget first).

The OpenAPI spec

The machine contract for the /v1 API:

Resource	URL
OpenAPI 3 spec (JSON)	`https://api.regsn.app/openapi.json`
OpenAPI 3 spec (YAML)	`https://api.regsn.app/openapi.yaml`
Human-readable reference	`https://api.regsn.app/reference`

The prose reference on this site (API for developers) and the spec describe the same surface; when generating code, prefer the spec.

The Agent Skill

regsn-api is an installable Agent Skill that teaches a coding agent the API: auth, the scan → snapshot → export object model, the canonical flows as curl, and the operational gotchas (rate buckets, polling cadence, error codes). Install it into any skills-aware agent:


npx skills add https://docs.regsn.app

The skill is discovered via /.well-known/skills/index.json; the skill document itself is at /skill/regsn-api/SKILL.md if you would rather read or vendor it directly.

Base prompt

For agents without skill support, paste this into the system or task prompt:


You are working with the Regulatory Snapshot API (https://api.regsn.app/v1).
Read https://docs.regsn.app/llms.txt for the documentation index; any docs
page is available as markdown by appending .md to its URL.
The OpenAPI spec is at https://api.regsn.app/openapi.json.
Auth: Bearer regsn_live_ API keys, minted in the dashboard at api.regsn.app.
Scans are async and take minutes: POST /v1/scans with an Idempotency-Key,
then poll GET /v1/scans/{id} every 5-10 seconds or stream the SSE endpoint.
Estimate cost first with POST /v1/scans/estimate; check GET /v1/usage/budget.
Errors are RFC 9457 problem+json with stable code values - branch on code.
Rate buckets: reads 60/min, scans 6/hour, exports 30/hour.