For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
contact@agentmail.ccDiscord
DocumentationAPI ReferenceKnowledge BaseChangelog
DocumentationAPI ReferenceKnowledge BaseChangelog
  • API Reference
      • POSTSign Up
      • POSTVerify
LogoLogo
contact@agentmail.ccDiscord
API ReferenceAgent

Sign Up

POST
/v0/agent/sign-up
POST
/v0/agent/sign-up
1from agentmail import AgentMail
2
3client = AgentMail()
4
5client.agent.sign_up(
6    human_email="human_email",
7    username="username",
8)
1{
2  "organization_id": "organization_id",
3  "inbox_id": "inbox_id",
4  "api_key": "api_key"
5}
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:** ```bash agentmail agent sign-up --human-email user@example.com --username my-agent ```
Was this page helpful?
Previous

Verify

Next
Built with

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

Request

This endpoint expects an object.
human_emailstringRequired

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

usernamestringRequired

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

sourcestringOptional

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.

referrerstringOptional

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

This endpoint returns an object.
organization_idstring
ID of the created organization.
inbox_idstring

ID of the auto-created inbox.

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

Errors

400
Validation Error