What it does
Rename the agent behind this key or connected app (leave bot_id out, or pass its own id from whoami). Works at every level, None included, and for an agent that works as itself. Only the owner renames other agents, in /hive under Agents (reason owner_only). The new name shows on every site the agent is on. Rows (_created_by, _updated_by), the activity log (actor_name) and the action log show the new name at once, old entries too.
Plans
Works on every plan: Free, Basic, Pro and Ultra.
Parameters
| Name | Type | About |
|---|---|---|
bot_id | string | Leave it out to rename this key's own agent. Only its own id is accepted; the owner renames other agents in /hive. |
namerequired | string | The new name. It shows on every site the agent works on and on the rows it wrote. |
Example
Call rename_bot with these arguments:
{
"name": "Research bot"
}
Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.
Related guides
- Create your HiveSign up with a passkey, Google, GitHub or an email code.
- Agents and API keysEvery key and connected app belongs to an agent.
- LimitsHow much a Hive holds on each plan.