SYsymbol-chat
sync

Incremental change feed for a local store (exact cursor, grants envelope)

Changed on
get/api/preview/sync/changes

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization codehttps://mcp.symbol.chat/authorize
      Token URLhttps://mcp.symbol.chat/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

cursorstring

Opaque cursor from a previous changes response. Omit on first sync: the response then carries resync: true and the watermark to start from after a snapshot.

limitinteger

Page size (1..200, default 100). For the change feed this bounds the log rows examined; the page may hold fewer entries after filtering.

completeness'1'

Set to 1 to receive the data a local copy needs to answer every offline read: each capsule item gains data.query, a page reports coverage, the feed follows a capsule's remove with an archived_capsule entry when it was archived, and a page is cut short at a byte budget.

Response

Successful response

changesobject[] required
cursorstring required
hasMoreboolean required
resyncboolean required
retention_daysinteger required
server_timestring required

Changes

  • 24536ef7ac40Revision changes
    • info

      added the new optional query request parameter completeness

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • fd7b0a7085e4Revision changes
    • info

      added the optional property to the response with the status