Documents

WebSocket upgrade to the realtime room. The op protocol is documented in docs/specs/015-api/api.md, not here.

get/documents/{id}/ws

Request

  • Base URL: https://www.livediagram.app/api
  • URL: https://www.livediagram.app/api/documents/{id}/ws
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Owner-Id

Path parameters

idstring required

Query parameters

sstring

Share code, for non-owner collaborators.

ostring

Owner id (guest path).

pstring

Share password, when the document is gated.

Changes

No recorded changes to this operation across all 1 revision of this API.