Inboxes

What this feature is for

An inbox represents a mailbox surface used for receiving, monitoring, and composing workflow-driven messages.

Standard flow for agents

  1. Create or read inbox list.
  2. Select target inbox for processing.
  3. Monitor using stream or periodic reads.
  4. Persist last processed position per inbox.

Endpoints

  • GET /api/v1/inboxes
  • POST /api/v1/inboxes
  • GET /api/v1/inboxes/{id}
  • DELETE /api/v1/inboxes/{id}
  • GET /api/v1/inboxes/{id}/warmup
  • GET /api/v1/inboxes/{id}/stream

Nested draft support

  • GET /api/v1/inboxes/{inbox_id}/drafts
  • POST /api/v1/inboxes/{inbox_id}/drafts
  • GET /api/v1/inboxes/{inbox_id}/drafts/{id}
  • PATCH /api/v1/inboxes/{inbox_id}/drafts/{id}
  • DELETE /api/v1/inboxes/{inbox_id}/drafts/{id}
  • POST /api/v1/inboxes/{inbox_id}/drafts/{id}/send

Guidance

  • Keep inbox operations scoped to selected account context.
  • Use warmup and stream endpoints for bootstrap + real-time behavior.

results matching ""

    No results matching ""