EaserixDocs
DevelopersAPI referenceNotesSystem

Internal: persist CRDT state (notes-sync only)

Stores the Yjs binary and projects the JSON doc through the standard save path (rev bump, snapshot throttling, wiki-link edges, search text). The sync server is authoritative during co-editing, except over writes made outside it: when baseRev is sent and the page's rev has moved past it (a REST save, version restore or copilot write while the page was open), the store is refused with 409 and the current doc, so notes-sync applies that write to the live document instead of overwriting it. Without baseRev the store is unconditional.

View as Markdown
PUT
/internal/pages/{id}/sync

Path Parameters

id*string
Formatuuid

Header Parameters

X-Internal-Key*string

Shared service secret (INTERNAL_API_KEY).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/internal/pages/497f6eca-6276-4993-bfeb-53cbbbba6f08/sync" \  -H "X-Internal-Key: string" \  -H "Content-Type: application/json" \  -d '{    "ydoc": "string"  }'
{  "rev": 0,  "updated": "2019-08-24T14:15:22Z"}