Manage Pods

Organize inboxes and resources into pod-scoped groups.

View as Markdown

Pods are tenant-owned containers used to scope inboxes and related routes.

Create and List Pods

curl -X POST "$API_URL/agent/v0/pods" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"client_id":"support-eu"}'
curl "$API_URL/agent/v0/pods?limit=20" \
  -H "Authorization: Bearer $API_KEY"

Manage Pod Inboxes

Create an inbox in a specific pod:

curl -X POST "$API_URL/agent/v0/pods/{pod_id}/inboxes" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username":"support","display_name":"Support EU"}'

Then use pod-scoped routes for lists, domains, drafts, threads, metrics, and API keys.

Deletion Rules

  • A pod cannot be deleted while it still has pod-scoped inboxes or domains.
  • Delete dependent resources first, then call DELETE /agent/v0/pods/{pod_id}.