CLI:

agentmail inboxes create --display-name "My Agent" --username myagent --domain agentmail.to

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an optional object.

• username string Optional

  Username of address. Randomly generated if not specified.

• domain string Optional

  Domain of address. Must be verified domain. Defaults to agentmail.to.

• display_name string Optional

  Display name: Display Name <username@domain.com>.

• client_id string Optional

  Client ID of inbox.

Response

This endpoint returns an object.

• pod_id string

  ID of pod.

• inbox_id string

  The ID of the inbox.

• email string

  Email address of the inbox.

• updated_at datetime

  Time at which inbox was last updated.

• created_at datetime

  Time at which inbox was created.

• display_name string

  Display name: Display Name <username@domain.com>.

• client_id string

  Client ID of inbox.

Errors

• 400

  Validation Error