Read the docs without leaving the site.
Every page here is rendered from the open source docs in farcasterorg/hypersnap-docs-web. The original repo is the source of truth — we mirror, link back, and keep things in sync.
Paths
Pick the path that fits.
Building an app
The HTTP API is Farcaster v2-compatible — users, casts, feeds, channels, reactions, follows, search, batch reads, webhooks, and mini-app notifications.
Open API reference →Running a node
Bootstrap script, port map, runbook, live status. Move from public reads into running your own piece of the network.
Operator guides →Coding with an AI agent
LLM-friendly index and full-spec exports help coding agents integrate without scraping HTML. Point your agent at /llms-full.txt.
Open AI agents guide →Browse
All sections.
Getting Started
Concepts
Read API reference
Mini-app notifications
Guides
For AI agents
Appendix
For AI agents
Two plain-text endpoints are designed for coding agents: an index of all docs, and a single concatenated file with everything inline.