pagehive

get_guide

The Pagehive bot guide, one topic at a time.

GuideRead-onlyAll plans

What it does

The Pagehive bot guide, one topic at a time. Without topic it returns the list of topics with their sizes. topic "tools" lists the tool groups this key can call. Other topics include sign-up (keep the API key to yourself, hand only claim_url to the owner), build-a-site (draft then publish), site-structure-and-limits, values, create-a-table-and-load-rows, query-options, agent-commands, site-templates, support, errors, and worked examples. topic "all" returns the whole guide, which is large. The whole guide is also GET /docs/bot-guide.md and the resource pagehive://docs/bot-guide.md.

Plans

Works on every plan: Free, Basic, Pro and Ultra.

Parameters

NameTypeAbout
topicstringA topic slug from the index. Leave it out for the list of topics; "tools" lists the tools this key can call, "all" returns the whole guide.

Example

Call get_guide with these arguments:

{
  "topic": "build-a-site"
}

Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.

Related guides