Page Presence
Tell Syntext you have a file open, see who else does, and leave when you close it.
Presence shows who else has a file open in the editor. Opening a file with GET /pages/{path}/content records you automatically. While the file stays open, send a heartbeat with POST at least every 2 minutes. When you close it, send DELETE.
/v1/projects/{projectId}/pages/{path}/presenceAny member of the workspace can call these, signed in with a session JWT — API keys are refused with 401. You must belong to the organization that owns {projectId}. Available on every plan. Neither call touches the repository.
Presence expires 120 seconds after your last content read or heartbeat, so a tab that closes without sending DELETE drops off on its own. Presence is best effort: when it is unavailable, editors is always empty and both calls still return 200.
Path Parameters
projectIdpathguides%2Fquickstart.mdx.Heartbeat — POST
Records that you have the file open, and returns the other people who do. You are never listed.
Response — 200 OK
Each editor's name is their display name, or the part of their email address before the @ if they have none. Full email addresses are never shown.
Leave — DELETE
Removes you from the file's editors.
Error Responses
400 Bad Request
invalid_path — {path} is not valid URL encoding.
401 Unauthorized
No session JWT, an expired one, or an API key.
403 Forbidden
forbidden — you are not a member of the organization that owns the project.
404 Not Found
not_found — the project does not exist or was deleted.