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

sessions

{session_id}

doc-events

Session Document Events

curl --request GET \
  --url https://api.superdocs.app/v1/sessions/{session_id}/doc-events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.superdocs.app/v1/sessions/{session_id}/doc-events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superdocs.app/v1/sessions/{session_id}/doc-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superdocs.app/v1/sessions/{session_id}/doc-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superdocs.app/v1/sessions/{session_id}/doc-events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.superdocs.app/v1/sessions/{session_id}/doc-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization

string | null

Path Parameters

session_id

string

required

Query Parameters

after_id

integer

default:0

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

Required range: x >= 0

include_own

boolean

default:false

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.

Response

Successful Response

Session Document Events

curl --request GET \
  --url https://api.superdocs.app/v1/sessions/{session_id}/doc-events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.superdocs.app/v1/sessions/{session_id}/doc-events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superdocs.app/v1/sessions/{session_id}/doc-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superdocs.app/v1/sessions/{session_id}/doc-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superdocs.app/v1/sessions/{session_id}/doc-events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.superdocs.app/v1/sessions/{session_id}/doc-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

v1

users

promo

uploads

agents

API Reference

mcp

Session Document Events

Authorizations

Headers

Path Parameters

Query Parameters

Response