v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB

Agent

Sign Up

Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.

A 6-digit OTP is sent to the human's email for verification.

This endpoint is idempotent. Calling it again with the same human_email will rotate the API key and resend the OTP if expired.

The returned API key has limited permissions until the organization is verified via the verify endpoint.

CLI:

agentmail agent sign-up --human-email user@example.com --username my-agent

post/v0/agent/sign-up

Request body

human_emailstring required

Email address of the human who owns the agent. A 6-digit OTP will be sent to this address.

usernamestring required

Username for the auto-created inbox (e.g. "my-agent" creates my-agent@agentmail.to).

sourcestring nullable

The SDK, framework, or platform issuing this sign-up (e.g. agentmail-python, agentmail-cli, agentmail-mcp). Identifies the caller — answers "who is signing up". Max 2048 characters.

referrerstring nullable

The channel that drove this sign-up — where the agent or its developer discovered AgentMail (e.g. agent.email, a partner URL, a campaign tag). Answers "where did this sign-up come from". Max 2048 characters.

Response

organization_idstring required

ID of the created organization.

inbox_idstring required

ID of the auto-created inbox.

api_keystring required

API key for authenticating subsequent requests. Store this securely, it cannot be retrieved again.