Workflow: Agent Onboarding

Fresh 🌱

The zero-dashboard path: an agent registers itself, verifies via OTP, then creates an inbox and sends its first email, all programmatically.

sequenceDiagram
    participant A as Agent
    participant API as AgentMail API
    participant H as Human (email)

    A->>API: POST /agent/sign-up { human_email, username }
    API-->>A: { api_key, inbox_id, organization_id }
    API->>H: OTP email (6-digit code)
    H-->>A: shares OTP code
    A->>API: POST /agent/verify { otp_code }
    API-->>A: full permissions unlocked
    A->>API: POST /inboxes { client_id }
    API-->>A: { inbox_id }
    A->>API: POST /inboxes/{id}/messages/send
    API-->>A: message queued

Steps

1. Sign up with the developer's email and an agent username. Receive api_key, inbox_id, organization_id. The call is idempotent (re-calling rotates the key and resends the OTP).
2. Verify the OTP the human received to unlock full permissions.
3. Create an inbox (the sign-up already gave you one, but agents can create more on demand).
4. Send the first email.

Full commands: SOP: Get an API Key → SOP: Create Your First Inbox → SOP: Send & Reply.

Related

Agent onboarding guide · Agent API · Permissions