hermes-agent/optional-skills/email/agentmail/references/signup.md
Haakam Aujla 14320d18df feat(skills): rewrite AgentMail optional skill CLI-first
Replaces the stale MCP-first AgentMail skill with CLI-first guidance:
self-signup + OTP verification, inbox/message/thread/label/attachment
flows, webhook and WebSocket delivery references, and MCP as an
alternative path. Declares AGENTMAIL_API_KEY (optional) so a stored key
reaches the sandboxed terminal while self-signup stays viable without
one.

Salvaged from PR #60811 — kept in optional-skills/ per the March 2026
decision that third-party-API-key skills are not bundled.
2026-08-27 07:09:26 -07:00

50 lines
1.1 KiB
Markdown

# AgentMail Self-Signup
Use this when the agent does not have an AgentMail API key. A human must receive
and provide the OTP.
## Sign Up
```bash
npm install -g agentmail-cli@latest
agentmail agent sign-up \
--human-email [email protected] \
--username my-agent \
--source agentmail-cli \
--referrer hermes-agent \
--format json
```
Export the returned `api_key`:
```bash
export AGENTMAIL_API_KEY="am_..."
```
Verify with the OTP:
```bash
agentmail agent verify --otp-code 123456
```
## Notes
- Use a real human email address for `--human-email`.
- `human_email` is the signup idempotency key, but signing up again with the
same email rotates the API key.
- Before verification, the account has one inbox, 10 sends/day, and can only
send to the signup human email.
## First Check
```bash
agentmail inboxes list --format json
agentmail inboxes:messages send \
--inbox-id [email protected] \
--to [email protected] \
--subject "AgentMail verified" \
--text "My AgentMail inbox is verified." \
--format json
```
Continue with [core.md](core.md).