Create a Yjs document

Designing

Staging

POST

/internal/documents

Documents

Initializes a new Yjs document for a room. Called by the control-plane when a room
is created, so the collab-plane can track the authoritative room phase and editor
lock state from the beginning of the room lifecycle.

If initialContent is provided, the document is seeded with that code.

Request

Authorization

API Key

Add parameter in header

X-Internal-Secret

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Document created

Bodyapplication/json

🟠400Bad Request

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location '/internal/documents' \
--header 'X-Internal-Secret: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "roomId": "550e8400-e29b-41d4-a716-446655440000",
    "initialContent": "def solution(nums):\\n    pass",
    "initialPhase": "waiting",
    "editorLocked": false
}'

Response Example

201 - Example 1

{
    "roomId": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": 1709467200000
}

Modified at 2026-04-09 21:45:02

MatchOpponent

Destroy a Yjs document