Skip to navigation

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.

human_email is optional. Without it, the inbox can receive email but cannot send to anyone until a human is attached with the attach human endpoint or, for a US-region inbox, claims it in the PostNuvia Console with the API key (see How do I claim my agent’s inbox?). There is also no way to recover the API key, so store it durably. Calling sign-up again without human_email creates a new organization, which needs a different username: the original username stays with the lost organization’s inbox.

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:

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

Request

This endpoint expects an object.
usernamestringRequired

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

human_emailstringOptional

Email address of the human who owns the agent. A 6-digit OTP will be sent to this address. Omit it to get a receive-only inbox: it can receive email but cannot send until a human is attached with the attach human endpoint.

sourcestringOptional

The SDK, framework, or platform issuing this sign-up (e.g. postnuvia-python, postnuvia-cli, postnuvia-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 PostNuvia (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