Liveblocks REST API

Name: Liveblocks REST API API
Brand: Liveblocks REST API
Availability: InStock

✓ Official Vendor SpecProductivityCollaborationbearer26 EndpointsREST

For Agents

Provision Liveblocks collaboration rooms, manage Yjs documents and storage, drive threaded comments and versions, and broadcast events to connected clients from a backend.

Quickstart

Get started with Liveblocks REST API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create a Liveblocks collaboration room"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Liveblocks REST API API.

Provision and configure collaboration rooms via POST /rooms, GET /rooms, and POST /rooms/{roomId}

Read and reset per-room storage via GET, POST, and DELETE /rooms/{roomId}/storage

Operate Yjs documents in JSON or binary form via /rooms/{roomId}/ydoc and /rooms/{roomId}/ydoc-binary

Manage threaded comments and reactions via /rooms/{roomId}/threads/{threadId}/comments endpoints

GET STARTED

Start building with Liveblocks REST API API

Explore with Jentic

View OpenAPI Document

Use for: I need to create a new Liveblocks collaboration room for a document, I want to broadcast an event to everyone connected to a room, Get the current Yjs document for a room as binary, List all threads in a collaboration room

Not supported: Does not handle video conferencing, voice, or end-user authentication UI — use for backend collaboration room, Yjs document, comment, and version management only.

Liveblocks is a real-time collaboration platform. Its REST API manages collaboration rooms, room storage, Yjs documents (binary and structured), threaded comments with reactions, and version snapshots for time-travel and audit. Built around the Room as the central resource, the API lets backend services provision rooms, broadcast events to connected clients, manage thread and comment lifecycles, and pull or initialise per-room storage. Authentication uses a Bearer token issued from the Liveblocks dashboard.

Use Cases

Patterns agents use Liveblocks REST API API for, with concrete tasks.

★ Server-Side Room Provisioning

Provision Liveblocks rooms from a backend when documents are created so collaboration is ready before any client connects. POST /rooms creates a room with a roomId and access permissions, GET /rooms lists existing rooms for management UIs, and DELETE /rooms/{roomId} cleans up when documents are deleted. Useful for SaaS apps that mirror room lifecycle to their own document objects.

POST /rooms with roomId={doc-id} and permissions, then DELETE /rooms/{roomId} when the document is removed.

Yjs Document Persistence

Persist or restore Yjs collaboration state outside of Liveblocks for backup, exports, or cross-environment promotion. GET /rooms/{roomId}/ydoc-binary returns the binary Yjs document, PUT /rooms/{roomId}/ydoc updates it, and the JSON variant via GET /rooms/{roomId}/ydoc supports inspection for debugging. Best when teams need to back up collaborative documents nightly or migrate state between staging and production.

Call GET /rooms/{roomId}/ydoc-binary nightly and store the bytes in object storage as a backup of the room's collaborative state.

Threaded Comments and Reactions

Power threaded comments, replies, and emoji reactions on top of Liveblocks rooms with a fully server-managed comment store. POST /rooms/{roomId}/threads creates a thread, POST /rooms/{roomId}/threads/{threadId}/comments adds replies, and POST /rooms/{roomId}/threads/{threadId}/comments/{commentId}/add-reaction handles reactions. Suitable for design tools, docs, and review experiences.

POST /rooms/{roomId}/threads to create a comment thread on a selection, then POST a child comment to /rooms/{roomId}/threads/{threadId}/comments.

Version Snapshots and Restore

Snapshot and restore room state to support undo, version history, and audit trails. POST /rooms/{roomId}/version creates a named version, GET /rooms/{roomId}/versions lists snapshots, and GET /rooms/{roomId}/version/{versionId} returns a specific snapshot. Useful for design tools and document apps that need point-in-time recovery without rebuilding their own version model.

POST /rooms/{roomId}/version every 10 minutes and GET /rooms/{roomId}/versions to render a version timeline in the UI.

AI Agent Collaboration Hooks

Let an AI agent join a Liveblocks-backed document, broadcast events, drop comments, or version-tag the room without holding the Bearer secret. Through Jentic, the agent searches by intent and gets the right /rooms or /threads endpoint with its schema while credentials stay in the MAXsystem vault. The agent can then react to user activity or post structured comments back into the document thread.

Search Jentic for 'broadcast a Liveblocks room event', load the schema, and execute POST /rooms/{roomId}/broadcast_event when the agent has a comment to deliver.

Key Endpoints

26 endpoints — liveblocks is a real-time collaboration platform.

METHOD

PATH

DESCRIPTION

POST

/rooms

Create a collaboration room

GET

/rooms

List rooms

POST

/rooms/{roomId}/broadcast_event

Broadcast event to room clients

GET

/rooms/{roomId}/ydoc-binary

Get Yjs document as binary

POST

/rooms/{roomId}/threads

Create a comment thread

POST

/rooms/{roomId}/threads/{threadId}/comments

Create a comment on a thread

POST

/rooms/{roomId}/version

Create a version snapshot

POST

/rooms

Create a collaboration room

GET

/rooms

List rooms

POST

/rooms/{roomId}/broadcast_event

Broadcast event to room clients

GET

/rooms/{roomId}/ydoc-binary

Get Yjs document as binary

POST

/rooms/{roomId}/threads

Create a comment thread

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Liveblocks Bearer secrets are stored encrypted in the Jentic MAXsystem vault and injected as the Authorization header at execution time — agents receive scoped tokens and never hold the raw secret.

Intent-based discovery

Agents search by intent (e.g., 'create a Liveblocks room' or 'broadcast a room event') and Jentic returns the matching /rooms or /threads endpoint with its input schema, removing manual navigation of the Liveblocks docs.

Time to first call

Direct Liveblocks REST integration: 4-8 hours for auth, room lifecycle, and Yjs handling. Through Jentic: under 30 minutes — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Pusher API

Hosted real-time messaging for channels and presence without document storage

Choose Pusher when the user only needs realtime messaging and presence — Liveblocks adds document storage, comments, and versions on top of that.

Alternative

Firebase API

Realtime Database and Firestore for backend-synced collaboration state

Choose Firebase when the user wants a general-purpose realtime database; choose Liveblocks when collaboration features (presence, comments, Yjs) should be turnkey.

Complementary

OpenAI API

LLM provider for agents that comment or summarise inside Liveblocks documents

Use alongside Liveblocks when an agent should generate comment content with an LLM and post it back into the room thread.

FAQs

Specific to using Liveblocks REST API API through Jentic.

What authentication does the Liveblocks REST API use?

The Liveblocks REST API uses Bearer token auth (the BearerAuth scheme in the spec). Tokens are issued from the Liveblocks dashboard. Through Jentic, the secret is held in the MAXsystem vault and injected as the Authorization header at execution time.

Can I create and broadcast to rooms with the Liveblocks API?

Yes. POST /rooms creates a room with a roomId and permissions, and POST /rooms/{roomId}/broadcast_event sends a custom event to all connected clients. GET /rooms/{roomId}/active_users returns the currently connected users for monitoring or presence-driven workflows.

What are the rate limits for the Liveblocks REST API?

Rate limits are enforced per project and tier, with stricter limits on write-heavy endpoints like /rooms/{roomId}/broadcast_event. Build agents to back off on 429 responses and to batch comment operations rather than calling /threads/{threadId}/comments in tight loops.

How do I create a Liveblocks room through Jentic?

Run pip install jentic, then search for 'create a Liveblocks collaboration room'. Jentic returns POST /rooms. Load the schema, supply roomId and permissions, and execute. Use DELETE /rooms/{roomId} when the document is removed to keep the room list clean.

Does the Liveblocks API expose Yjs documents directly?

Yes. GET /rooms/{roomId}/ydoc returns the document as JSON for inspection, GET /rooms/{roomId}/ydoc-binary returns it in Yjs binary form for backup or migration, and PUT /rooms/{roomId}/ydoc updates the document state. Use the binary form for round-trip persistence.