Create API Key | AgentMail

from agentmail import AgentMail
from agentmail.api_keys import CreateBearerApiKeyRequest
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.api_keys.create(
    request=CreateBearerApiKeyRequest(),
)

{
  "api_key_id": "api_key_id",
  "api_key": "api_key",
  "prefix": "prefix",
  "name": "name",
  "pod_id": "pod_id",
  "inbox_id": "inbox_id",
  "permissions": {
    "inbox_read": true,
    "inbox_create": true,
    "inbox_update": true,
    "inbox_delete": true,
    "message_read": true,
    "message_send": true,
    "message_update": true,
    "message_delete": true,
    "label_spam_read": true,
    "label_blocked_read": true,
    "label_unauthenticated_read": true,
    "label_trash_read": true,
    "draft_read": true,
    "draft_create": true,
    "draft_update": true,
    "draft_delete": true,
    "draft_send": true,
    "webhook_read": true,
    "webhook_create": true,
    "webhook_update": true,
    "webhook_delete": true,
    "domain_read": true,
    "domain_create": true,
    "domain_update": true,
    "domain_delete": true,
    "list_entry_read": true,
    "list_entry_create": true,
    "list_entry_delete": true,
    "metrics_read": true,
    "api_key_read": true,
    "api_key_create": true,
    "api_key_update": true,
    "api_key_delete": true,
    "provider_connect": true,
    "provider_share_owner": true,
    "account_update": true,
    "pod_read": true,
    "pod_create": true,
    "pod_delete": true
  },
  "created_at": "2024-01-15T09:30:00Z"
}

Creates a bearer key, or registers a public key when the body carries public_key. The route selects the scope. Bearer secrets are returned once.

CLI:

agentmail api-keys create --name "My Key"

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

Create Bearer API Key RequestobjectRequired

Create Public Key RequestobjectRequired

Response

This endpoint returns an object.

Create API Key Responseobject

Public Key Credentialobject

Errors

400

Validation Error

409

Conflict Error