EaserixDocs
DevelopersAPI referenceNotesSystem

Internal: read CRDT state (notes-sync only)

Service-to-service surface for the notes-sync realtime server, gated by the X-Internal-Key shared secret (501 when unconfigured). Returns the stored Yjs binary state (base64, empty when none) plus the current JSON projection and rev so a fresh Y.Doc can be seeded.

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

Path Parameters

id*string
Formatuuid

Header Parameters

X-Internal-Key*string

Shared service secret (INTERNAL_API_KEY).

Response Body

application/json

curl -X GET "https://example.com/internal/pages/497f6eca-6276-4993-bfeb-53cbbbba6f08/sync" \  -H "X-Internal-Key: string"
{  "ydoc": "string",  "doc": {},  "rev": 0}

Liveness probe

Unauthenticated liveness check used by the platform and monitors.

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 — no optimistic rev check.