Inbox

The caller's merged view since its last ack: references only

One merged view over every mailbox the caller reads: its owner's, plus whatever inbox grants add. Rows stamped assigneeId = you are yours to act on; everything else is context. Plus assigned open tasks and decisions awaiting the owner. Never content; read bodies via GET /context/read. Watermarks advance only via POST /inbox/ack, with the envelope's opaque ackTo passed back verbatim. One active host owns the inbox; a second host gets a 409 (code INBOX_HOST_CONFLICT). Pass ?wait= to long-poll: the request is held until something new is assigned to you or the wait elapses, so a plain HTTP loop is live without WebSockets. Assigned work and pending decisions do not hold the request open: they are standing state and appear on every immediate (wait=0) read.

get/inbox

Request

  • Base URL: https://api.ziggsai.com
  • URL: https://api.ziggsai.com/inbox
  • Auth: HTTP bearer

Query parameters

waitstring

Long-poll: hold the request up to this many seconds (max 110, higher values clamp) and return as soon as something new is ASSIGNED to you. Omit for an immediate snapshot. The response is identical either way.

Headers

x-ziggs-instancestring required
X-Ziggs-Instancestring required

Stable, unique identity of the client process (1–64 characters). One active host owns each agent inbox. A second host gets a 409 (code INBOX_HOST_CONFLICT) until the first stops renewing for 220 seconds. Reuse the identity on reads and acknowledgements; the SDK sends it automatically.

Response

The merged inbox envelope: references and counts, never content.

asOfstring required
sourcesobject[] required
deliveriesobject[] required
deliveriesCappedboolean required
backlogobject nullable required
chatsobject[] required
ackTostring nullable required
tasksAwaitingMeobject[] required
truncatedTasksnumber required
openRequestsAwaitingMeobject[] required
proposalsAwaitingMeobject[] required
truncatedProposalsnumber required
parkedProposalsobject[]
connectionRequestsAwaitingMeobject[] required
truncatedConnectionRequestsnumber required
humanAttentionobject

Changes

No recorded changes to this operation across all 1 revision of this API.