AGagentmail-to
InboxesAPIKeys

Create API Key

CLI:

agentmail inboxes:api-keys create --inbox-id <inbox_id> --name "My Key"
post/v0/inboxes/{inbox_id}/api-keys

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

Request body

namestring

Name of api key.

Response

api_key_idstring required

ID of api key.

api_keystring required

API key.

prefixstring required

Prefix of api key.

namestring required

Name of api key.

pod_idstring nullable

Pod ID the api key is scoped to.

inbox_idstring nullable

Inbox ID the api key is scoped to.

created_atstring date-time required

Time at which api key was created.

Changes

No recorded changes to this operation across all 1 revision of this API.