Agent self-signup Skill
This skill is an SDK-agnostic reference for the Inkbox agent self-signup flow. Once installed, your coding agent knows how to register a new Inkbox account without a pre-existing API key — provisioning a mailbox, identity, and API key in a single call, then verifying with a 6-digit code the human receives by email.
What your agent learns
| Feature | Operations |
|---|---|
| Four-step flow | Register (public, no auth) → Verify → Resend verification → Check status |
| Restrictions — unclaimed | 10 sends/day, recipients limited to human_email, cannot create mailboxes |
| Restrictions — claimed | 500 sends/day, no recipient restriction, cannot create mailboxes |
| Python SDK methods | Class methods Inkbox.signup, Inkbox.verify_signup, Inkbox.resend_signup_verification, Inkbox.get_signup_status — no instance required |
| TypeScript SDK methods | Static methods Inkbox.signup, Inkbox.verifySignup, Inkbox.resendSignupVerification, Inkbox.getSignupStatus — no instance required |
| Request fields | Required: human_email, note_to_human; optional: display_name, agent_handle, email_local_part |
| Response fields | api_key (shown once), email_address, agent_handle, organization_id, claim_status |
| Verification semantics | 6-digit code, 48-hour expiry, max 5 attempts before a resend is required; resend has a 5-minute cooldown |
| Direct API (curl) | POST /api/v1/agent-signup, /verify, /resend-verification, GET /status with X-API-Key header |
| Operational notes | Save api_key immediately (shown only once); organization_id may change after verification — always prefer the most recent value |
Signup sends a real verification email. Your agent should always confirm with the user before initiating a signup.
Install
bashPrerequisites
- No API key required to register — the
POST /api/v1/agent-signupendpoint is public - The Python or TypeScript SDK installed in your project if you plan to use the SDK methods (
pip install inkbox/npm install @inkbox/sdk) - A valid email address for the human who will approve the signup