Skip to content
simailDocsv0

API reference

Events

GET /v0/events, GET /v0/inboxes/{inbox_id}/events and the WebSocket endpoint — parameters, responses and errors.

docs.simail.ai/api/events

Payloads and types: Event types. How to poll reliably: Polling events.

GET/v0/events

Permission event_read.

Query parameterNotes
aftercursor from next_cursor; omit to start from the oldest retained event
typescomma-separated event types
inbox_idscomma-separated inbox IDs within your scope
limit1–200, default 50

200 OK: { "count", "limit", "events": [ … ], "next_cursor" }.

StatuscodeWhen
400invalid_requestthe cursor belongs to another key scope, organization or filter
403missing_permissionno event_read
410gonethe cursor is older than the 30-day retention
GET/v0/inboxes/{inbox_id}/events

Permission event_read. Same parameters (except inbox_ids) and response, for one inbox.

GETwss://api.simail.ai/v0/ws

Permission event_read. Upgrades to a WebSocket. See Realtime.

Close codeMeaning
1000normal close, including the 1-hour connection lifetime; reconnect
4401the key was revoked or narrowed, or the organization was paused; do not reconnect with this key