API reference

Sync and realtime

3 endpoints · Overview

GET/v1/spaces/{sid}/snapshot

Full listing of live nodes for the first sync; read the journal after the first page's at_seq

Bearer token

Example request

curl "https://side.example.com/v1/spaces/spc_01JD7Q2M8X4V6N0R3T5W9Y1B2C/snapshot" \
  -H "Authorization: Bearer $SIDESPACE_TOKEN"

Example response · 200

{
  "nodes": [
    {}
  ],
  "at_seq": 1,
  "next_cursor": "next_cursor"
}

Changes after a seq, strictly ordered and gap-free

Bearer token

Example request

curl "https://side.example.com/v1/spaces/spc_01JD7Q2M8X4V6N0R3T5W9Y1B2C/journal?after=1" \
  -H "Authorization: Bearer $SIDESPACE_TOKEN"

Example response · 200

{
  "entries": [
    {}
  ],
  "last_seq": 1,
  "has_more": false
}

WebSocket for realtime signals (see proto/ws.md). Auth by bearer header or ?access_token=.

Bearer token

Example request

curl "https://side.example.com/v1/ws" \
  -H "Authorization: Bearer $SIDESPACE_TOKEN"