Skip to main content
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. View the source →

What your agent learns

An A2A invitation may change the flow: include it in the initial signup rather than registering first and requesting a verification code. SDK and CLI signup accept either its link or raw token through their invitation fields, while direct REST uses the raw token in invitation_token. An email-bound invitation with a matching human email auto-claims and connects the identity without a second email, while a manual-handoff invitation reserves the connection until ordinary verification succeeds. See Connection invitations.
Ordinary signup sends a real verification email, while invitation-assisted signup may connect immediately. Your agent should always confirm with the user before initiating signup.

Install

bash

Prerequisites

  • No API key required to register — the POST /api/v1/agent-signup endpoint 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