September 16, 2026 | AgentMail

Summary

POST /v0/inboxes/{inbox_id}/authorize now returns only what the agent needs after authorizing a waiting sign-in: the key’s api_key_id and an instructions line. The full key, including status and permissions, is read with Get API Key, the same call every other credential uses.

Breaking changes

⚠️ The authorize response no longer carries the pending public key’s fields. Read status, permissions, and expires_at from GET /v0/api-keys/{api_key_id} instead.

Migration guide:

import os
import httpx
headers = {"Authorization": f"Bearer {os.environ['AGENTMAIL_API_KEY']}"}
response = httpx.post(
    "https://api.agentmail.to/v0/inboxes/agent%40example.com/authorize",
    headers=headers,
    json={"auth_token": os.environ["AGENTID_AUTH_TOKEN"]},
    timeout=30,
)
response.raise_for_status()
authorization = response.json()
# before
# print(authorization["status"])
# after: read the key for its status
key = httpx.get(
    f"https://api.agentmail.to/v0/api-keys/{authorization['api_key_id']}",
    headers=headers,
    timeout=30,
)
key.raise_for_status()
print(key.json()["status"])

See Authorize Inbox and the AgentID Sign-In guide.