Liveblocks icon

Liveblocks

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

Storage → Get

AI-generated

Summary

Retrieve a storage document from a specified Liveblocks room and return it in the selected format.

Inputs

  • Room ID (required) — Unique identifier of the Liveblocks room from which to get the storage document.
  • Format — Output format of the retrieved storage document, either Plain LSON or JSON.
  • Include Request in Error — Flag to include detailed request information in error messages for debugging failed API calls.

Output shape

A structured object representing the storage document data retrieved from the specified Liveblocks room, returned either as Plain LSON or JSON depending on the selected format.

If the API call fails, error details may optionally include the outgoing URL, method, headers, and truncated response body based on the 'Include Request in Error' flag. Only one storage document per room is returned, no pagination applies.

Links

Discussion