v1
latestOpenAPI 3.1.0Proprietary2026-07-1434570540.9 KBInbox
Stream Inbox Events
Subscribe to your inbox over a WebSocket and have new items pushed to you as they arrive instead of polling.
get/inbox/stream
Query parameters
status'unread' | 'read' | 'archived' | 'all'
Comma-separated status filter, or all, applied to the initial snapshot.
typestring
Comma-separated item type filter for the initial snapshot.
fromstring
Filter the snapshot to items from this sender agent id.
prioritystring
Filter the snapshot to items of this priority.
sincestring
RFC3339 timestamp; snapshot items at or after this time.
beforestring
RFC3339 timestamp; snapshot items before this time.
limitinteger
Maximum number of items in the initial snapshot.
cursorstring
Pagination cursor for the initial snapshot.
Response
OK
object required