Developers
Build on the platform
Integrate with a HANK product API, or build on the documentation platform itself. Product API references come first; the docs platform ships its own REST API, an MCP server, and machine-readable docs.
Product APIs
The APIs customers integrate with. Each HANK product that exposes an API publishes its own reference: the operations, parameters, authentication, and example requests.
Docs platform API
- API quickstartIssue a token, make your first REST call, publish a topic, handle the error-code catalog and rate-limit headers, and call the MCP server.
- Platform API referenceThe complete /api/v1 surface as an interactive OpenAPI 3.1 reference.
- Agent integration guidePatterns for LLM agents: discovery, search, fetching Markdown twins, citing sources with deep links, MCP, and RAG.
- Resource lifecycle guideCreate, update, publish, and retract resources over the API, covering the full CRUD lifecycle and the publish-policy gate.
- API error codesThe complete catalog of stable machine-readable error codes the REST API can emit, each with its HTTP status and meaning.
- Webhook endpointsRegister HTTPS endpoints to receive signed event pushes for doc updates, changelog entries, and ticket resolutions, then view per-endpoint delivery logs and rotate signing secrets. Sign-in required.
Direct machine surfaces
Prefer to integrate directly? These endpoints are public and unauthenticated for reads:
/api/v1/openapi.json: the self-describing OpenAPI 3.1 spec for the bearer-gated REST API/api/openapi.json: the OpenAPI 3.1 spec for the public content API (structure, search, section, changelog, glossary, ask), no auth required/mcp: the Model Context Protocol server (JSON-RPC)/llms.txt: the machine-readable index (plus /llms-full.txt for the full corpus)