For AI agents
These docs are built to be read by coding agents and LLM tools as well as people.
Markdown for every page
Add .md to any page's URL to get it as plain Markdown, with code examples and links to other pages' Markdown:
https://sigwise.ai/docs/guide/quickstart → HTML
https://sigwise.ai/docs/guide/quickstart.md → MarkdownEvery HTML page also advertises its Markdown in its head:
html
<link rel="alternate" type="text/markdown" href="/docs/guide/quickstart.md">Each page has buttons to copy its Markdown or open it in Claude or ChatGPT. The API reference has a Markdown version too, /docs/reference.md, generated from the OpenAPI specification.
llms.txt
| File | Contains |
|---|---|
/llms.txt | An index of every page, with a one-line description and its Markdown URL (llmstxt.org). Also at the domain root, https://sigwise.ai/llms.txt. |
/llms-full.txt | Every page, including the API reference, in one file. Give it to an agent as context. |
llms.txt starts with a short summary of the product and its pricing. The landing page has a Markdown version too, at https://sigwise.ai/index.md.
The API contract
For code generation and tool calling, use the OpenAPI 3.1 specification rather than prose: /docs/openapi.json or /docs/openapi.yaml. The API serves the one for the version it runs at /openapi.json. See OpenAPI specification.
Tips for agents writing integrations
- Authentication needs a fresh HS256 JWT per request, signed with the API key's secret; see Authentication. Prefer an SDK, which does this for you.
- Request bodies are decoded strictly: unknown fields are a
400. - Never retry
POST /v1/objects/{object_id}/eventsblindly; it isn't idempotent. See Errors and retries.