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
transitions to a state that requires collaborative editing (e.g., when the first
participant joins or when the room moves to the coding phase).

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

Body

🟠400Bad Request

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

201 - Example 1

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

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

MatchOpponent

Destroy a Yjs document