---
title: "WebSocket upgrade to the realtime room. The op protocol is documented in docs/specs/015-api/api.md, not here."
method: GET
path: "/documents/{id}/ws"
tags: ["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

- `id` string, required

## Query parameters

- `s` string
- `o` string
- `p` string

## Other responses

- `101`: Switching Protocols (WebSocket upgrade).
- `403`: Error.
- `404`: Error.

---

[API](https://skmtc.dev/livediagram/apis/livediagram-api.md) · [All operations](https://skmtc.dev/livediagram/apis/livediagram-api/llms.txt) · [OpenAPI document](https://skmtc.dev/livediagram/apis/livediagram-api/revisions/f286d27acfd2?raw)