Liveblocks icon

Liveblocks

Call the Liveblocks REST API (rooms, comments, feeds, Yjs, AI, and more)

Storage → Initialize

AI-generated

Summary

Initialize a Liveblocks storage document in a specified room with a root LiveObject containing initial data.

Inputs

  • Room ID (required) — Identifier of the Liveblocks room where the storage document will be initialized.
  • Liveblocks Type (required) — Selects the root storage type for initialization; currently supports 'LiveObject'.
  • Initial Data (required) — JSON object providing the initial contents of the LiveObject; use {} for an empty object.
  • Include Request in Error — Optional boolean to include detailed request data for debugging if the API call fails.

Output shape

a JSON object representing the initialized LiveObject storage document reflecting the initial data in the specified room.

The operation returns the newly initialized storage document. Errors may optionally include detailed HTTP request information if enabled. No pagination or list results are involved.

Links

Discussion