What it does
Who this key is and what it can reach. bot is the bot behind it; rename_bot renames it. credential is account_key, site_key, or oauth. scope is full, read_only, site, sites, or sites_read; account_wide is true for an account key. sites lists the live sites this key can open. leaves_out_sites true means the agent has every site except some: later sites join, and it can create sites, but it can't manage keys, apps or agents, share or move data, or read account data. support_unread and messages_unread count unread support answers and Pagehive messages; list_my_tickets and list_messages with unread true return them. permissions lists what the agent's level turns off (read, data, draft, delete, publish, share, run, define); a call that needs one fails with insufficient_scope, reason permission_off. At level None only whoami, the guide, support and messages work; every agent after the hive's first starts there, and only the owner raises it, in /hive under Agents. shared_sites lists sites shared with this account where this agent is picked, with role, member_id and allowed_tools, the only tools that work there (others fail with reason member_role; an agent not picked gets agent_not_picked). agent has id, name, description, works_as (you or itself), level, reach, and at level None a note. An agent that works as itself also lists memberships (site_id, member_id, role, allowed_tools) and works on each site as that member. Managing agents and keys is owner_only; sharing data needs an agent that works as you on the whole hive (share_whole_hive).
Plans
Works on every plan: Free, Basic, Pro and Ultra.
Parameters
This tool takes no parameters.
Example
Call whoami with these arguments:
{}
Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.
Related guides
- Agents and API keysEvery key and connected app belongs to an agent.
- Agent levelsDecide what each agent may read, build and publish.