SYsymbol-chat
sync

One keyset page of currently readable rows of one entity kind for a local store

Changed on
get/api/preview/sync/snapshot

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

Query parameters

entity'capsules' | 'types' | 'projects' | 'collections' | 'collection_members' | 'archived_capsules' | 'log_entries' required

Which entity kind this page carries.

cursorstring

Opaque nextCursor from the previous page of the same entity. Omit for the first page.

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.

wsstring

Workspace scope: all (default) for every workspace in the caller's grants, personal, or an organization id that is in the grants.

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.

capsule_idstring

Only with entity=log_entries: the entries of this one log capsule, for a client whose stored log_revision differs from the one a capsule item reported.

Response

Successful response

entity'capsules' | 'types' | 'projects' | 'collections' | 'collection_members' | 'archived_capsules' | 'log_entries' required
hasMoreboolean required
itemsobject[] required
nextCursorstring nullable required

Changes

  • 24536ef7ac40Revision changes
    • warning

      added the new archived_capsules enum value to the response property for the response status

    • warning

      added the new log_entries enum value to the response property for the response status

    • info

      added the new optional query request parameter capsule_id

    • info

      added the new optional query request parameter completeness

    • info

      added the new enum value archived_capsules to the query request parameter entity

    • info

      added the new enum value log_entries to the query request parameter entity

    • 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