Set up with your AI agent
Copy this prompt into Claude Code, Codex, Cursor or ChatGPT. It installs the Hive3 CLI and skill and signs you in.
Prompt for your agentagent-setup.md
Set up the Hive3 command-line tool (hive3) and the Hive3 agent skill on this machine, then sign me in. Documentation: https://docs.hive3.tech/developers Ground rules: - Do not change anything in my Hive3 account. This setup only reads. - Never ask me for an API key and never print or open the CLI's credential file. I sign in through my own browser. - Hive3 developer access needs a Honey Bee plan or above. If the sign-in page says a Honey Bee subscription is required, tell me and stop. - If you cannot run shell commands (for example in a chat app), do not pretend. Give me the commands below as a numbered list to run myself, and wait for what they print. Steps: 1. Run `node --version`. It must be v20 or newer; if it is missing or older, tell me and stop. 2. Run `npm install --global @hive3/cli@latest`. 3. Run `hive3 --version`. It must print 0.4.0 or newer; if not, tell me and stop. 4. Install the Hive3 skill for the agent you are: `hive3 skill install --agent claude` (Claude Code), `hive3 skill install --agent codex` (Codex) or `hive3 skill install --agent cursor` (Cursor). For any other agent, run `hive3 skill install --dir <your skills directory>`. Tell me if I need to start a new session so the skill loads. 5. Run `hive3 login --access read --no-open`. It prints an approval URL and a one-time code, then waits. Start it in the background, or otherwise stream its output, so you can read it while it waits. Show me the URL and the code exactly as printed, ask me to open the URL, sign in, type the code and approve, and wait until the command finishes. 6. Run `hive3 whoami` and `hive3 capabilities`. Summarize for me: the account I signed in as, the scopes of the key, and which accounts it can act on. 7. Tell me this key is read only. For write access later I can ask you to run `hive3 login --access full`, which needs my approval in the browser again. Do not run it unless I ask.
Hive3 has a public API, a command-line tool called hive3, and an agent skill that lets an AI assistant use the command-line tool for you. All three act as an account you control, with the same rules, limits and plan checks as the Hive3 app.
#What you can build
- Publishing automations. Create and update posts, events, courses, content, quests and jobs from a script, a scheduler or a CMS.
- Community operations. Review applications, change member roles, approve RSVPs and enrollments, record attendance, and review quest evidence.
- Email broadcasts. Draft, test, schedule and send email to a community's opted-in members.
- Credentials. Award custom credentials to people by handle and read who holds what.
- Support tooling. Manage the AI assistant's name, visibility and training documents.
- Dashboards and reports. Read tickets, search results, notifications, members and participants into your own tools.
#API, CLI or agent skill
| Public API | hive3 command-line tool | Agent skill | |
|---|---|---|---|
| What it is | HTTP endpoints that return JSON | A Node.js program that calls the API for you | Instructions that teach an AI agent to use hive3 safely |
| Sign in | API key you create in Settings | Browser approval; the key is stored for you | Uses the signed-in hive3 session |
| Best for | Servers, integrations, anything in code | Terminals, shell scripts, CI jobs, quick checks | Letting an assistant manage your account under your supervision |
| Start here | Authentication and API keys | CLI quickstart | Use Hive3 with AI agents |
#Make your first request
Create an API key
Open SettingsHelp & feedbackDeveloper API keysManage API keys and select Create API key. Copy the key when it appears; it is shown once. See Authentication and API keys.
Call the API
Send the key as a Bearer token. This request returns the account behind the key and the accounts it can act on.
Who am I?curl https://app.hive3.tech/api/v1/me \ -H "Authorization: Bearer $HIVE_API_KEY"Read the response
Every successful response wraps its payload in
data. Errors use anerrorobject with a stablecode. See Requests, errors and limits.
#Explore the documentation
Authentication and API keysCreate keys, choose scopes, and act on communities you manage.Requests, errors and limitsResponse format, error codes, pagination, idempotency and rate limits.Events, courses, content, quests, jobsCreate and manage the things people join.BroadcastsDraft, test and send email to your members.CLI quickstartInstall
hive3, sign in, and run your first commands.Use Hive3 with AI agentsGive an assistant least-privilege access to your account.#Reference pages
| Area | Page |
|---|---|
| Account and profile | Account and profile, Account settings |
| Wallets, data export, deletion | Wallets, Export and deletion |
| File uploads | Uploads |
| Posts and comments | Posts and comments |
| Events, courses, content, quests, jobs | Shared rules and jobs, Events, Courses and content, Quests |
| RSVPs, enrollments, evidence, applications | Event workflows, Course and job workflows, Quest workflows |
| Membership, roles, access | Communities and members |
| Notifications and mutes | Notifications |
| Search | Search |
| Email broadcasts | Broadcasts |
| Tickets | Tickets |
| AI assistant | AI assistant |
| Credentials | Credentials |
#Good to know
- One version. The API lives under
/api/v1. Existing paths, scopes and field names do not change. Some field names still use the older wordspersonandcommunity; both refer to Hive3 accounts. A community is an account that other people join. - The key acts as you. A request never names the acting account. Hive3 resolves it from the key. Access to other accounts you help run depends on your role there at the moment of the request.
- Not available. The API and CLI do not handle wallet keys or signing, payments or refunds, credential creation or minting, private messages, or hard deletion of communities. They can change which wallets and NFTs are publicly visible.