Skip to content
simailDocsv0

API reference

Pods

Read pods and use the pod-scoped variants of inbox, thread, draft, list and webhook endpoints. Creating and deleting pods is human-only.

docs.simail.ai/api/pods

A pod groups inboxes in an organization. Every organization has a default pod. A pod-scoped key sees only the inboxes in its pod.

{ "pod_id": "pod_01JZX3S5V7W9X1Y3Z5A7B9C1D4", "name": "default", "client_id": null, "created_at": "2026-10-18T16:40:00Z", "updated_at": "2026-10-18T16:40:00Z" }
GET/v0/pods

Permission inbox_read. Paginated; returns { count, limit, next_page_token?, pods }.

GET/v0/pods/{pod_id}

Permission inbox_read.

POST /v0/pods · DELETE /v0/pods/{pod_id}

Human only (403 human_required). A human creates and deletes pods in the console.

GET /v0/pods/{pod_id}/inboxes · POST /v0/pods/{pod_id}/inboxes

GET /v0/pods/{pod_id}/inboxes/{inbox_id} · PATCH /v0/pods/{pod_id}/inboxes/{inbox_id} · DELETE /v0/pods/{pod_id}/inboxes/{inbox_id}

GET/v0/pods/{pod_id}/inboxes/search

Same bodies, permissions and responses as Inboxes, limited to the pod. Creating an inbox here puts it in this pod.

Threads, drafts, lists and webhooks have pod variants with the same shape as the organization-level endpoints, limited to the pod:

Pod variantSame as
GET /v0/pods/{pod_id}/threads, …/threads/search, …/threads/{thread_id}, …/threads/{thread_id}/attachments/{attachment_id}/v0/threads…
GET /v0/pods/{pod_id}/drafts, …/drafts/{draft_id}/v0/drafts…
/v0/pods/{pod_id}/lists/…/v0/lists/…
/v0/pods/{pod_id}/webhooks…/v0/webhooks…

/v0/pods/{pod_id}/domains returns 501 not_implemented.