Liveblocks icon

Liveblocks

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

Room → Prewarm

AI-generated

Summary

Prewarm a Liveblocks room by its ID to prepare or optimize server-side resources associated with that room.

Inputs

  • Room ID (required) — Liveblocks room identifier to prewarm.
  • Include Request in Error — Optionally include details of the failed API request in error messages for debugging purposes.

Output shape

a JSON object representing the result of the prewarm API call (details depend on Liveblocks API response).

The response shape corresponds to the Liveblocks API's prewarm room endpoint output. Errors include optional request details if 'Include Request in Error' is enabled.

Examples

Example 1: Prewarm a specific room with ID 'room_12345' to optimize its backend initialization before use in a workflow.

Set 'Room ID' to 'room_12345'. Leave 'Include Request in Error' disabled or enable for detailed error debugging.

Links

Discussion