v1
sessions

Session Document Events

Poll for cross-session document updates: returns document_updated events for documents THIS session holds that OTHER sessions committed since after_id. The client polls this (~every 1-2s while a doc is open) and re-fetches the changed document's content so all open sessions converge without a refresh. Excludes this session's own writes by default (the web UI already has its own changes); a REST/MCP integrator can pass include_own=true to receive its own events too. REST-only — a lightweight poll, deliberately NOT an MCP tool and NOT a held SSE connection (keeps the per-instance connection budget free).

get/v1/sessions/{session_id}/doc-events

Request

  • Base URL: https://api.superdocs.app
  • URL: https://api.superdocs.app/v1/sessions/{session_id}/doc-events
  • Auth: HTTP bearer

Path parameters

session_idstring required

Query parameters

after_idinteger

Return events with id greater than this (the poll cursor).

include_ownboolean

Integrator opt-out: when true, ALSO return this session's own document_updated events (default false excludes them — the web UI never needs its own writes echoed). A REST/MCP integration that writes on one connection and polls on another, or wants a complete change feed for the docs it holds, sets this true.

Headers

authorizationstring nullable

Response

Successful Response

unknown required

Changes

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