Destroy a Yjs document

Designing

Staging

DELETE

/internal/documents/{roomId}

Documents

Tears down the Yjs document for a room. Called by the control-plane when a room
is deleted or transitions to finished status. Returns the final document snapshot
(binary Yjs state vector as a byte array) for archival in the session record.

All connected WebSocket clients for this document are disconnected with close
code 4003 (Room Closed).

Request

Authorization

API Key

Add parameter in header

X-Internal-Secret

Example:

X-Internal-Secret: ********************

Path Params

Responses

🟢200OK

application/json

Document destroyed. Returns final snapshot for archival.

Body

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/internal/documents/' \
--header 'X-Internal-Secret: <api-key>'

Response Example

200 - Example 1

{
    "roomId": "550e8400-e29b-41d4-a716-446655440000",
    "finalSnapshot": [
        1,
        2,
        3,
        4,
        5
    ]
}

Modified at 2026-03-11 21:59:03

Create a Yjs document

Kick a user from the document