Read a Parallax doc
read_docRead-onlyIdempotent
Returns a page of the Parallax documentation or a PIP in full, as Markdown: by "path" from search_docs (such as "guides/mining/pool" or "pip-0004"; "PIP-4", a parallax://docs URI or a docs.parallaxprotocol.org URL also work). Long pages come in parts of "max_bytes" (default 24,000): pass "next_offset" back as "offset" for the rest. Includes the page's published url, to cite.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | page path from search_docs, such as guides/mining/pool or pip-0004 | |
| offset | No | byte offset to start from, for long pages (next_offset of the previous call) | |
| max_bytes | No | how much to return, 1000-120000 bytes (default 24000) |