---
meta:
  title: "API Reference"
  description: "API reference for Liveblocks packages and APIs"
---

API reference documentation for Liveblocks packages, REST API, and webhook
events. To install Liveblocks, follow our [quickstart guides](/docs/get-started)
or start with a prompt.

<GetStartedPromptCta title="Get started with a prompt" />

## Client packages

<ListGrid columns={2}>
  <DocsCard
    type="technology"
    title="JavaScript"
    href="/docs/api-reference/liveblocks-client"
    description="@liveblocks/client"
    visual={<DocsJavascriptIcon />}
  />
  <DocsCard
    type="technology"
    title="React"
    href="/docs/api-reference/liveblocks-react"
    description="@liveblocks/react"
    visual={<DocsReactIcon />}
  />
  <DocsCard
    type="technology"
    title="React UI"
    href="/docs/api-reference/liveblocks-react-ui"
    description="@liveblocks/react-ui"
    visual={<DocsReactIcon />}
  />
  <DocsCard
    type="technology"
    title="React Flow"
    href="/docs/api-reference/liveblocks-react-flow"
    description="@liveblocks/react-flow"
    visual={<DocsReactIcon />}
  />
  <DocsCard
    type="technology"
    title="CodeMirror"
    href="/docs/api-reference/liveblocks-codemirror"
    description="@liveblocks/codemirror"
    visual={<DocsCodeEditorIcon className="h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="ProseMirror"
    href="/docs/api-reference/liveblocks-prosemirror"
    description="@liveblocks/prosemirror"
    visual={<DocsJavascriptIcon />}
  />
  <DocsCard
    type="technology"
    title="React Tiptap"
    href="/docs/api-reference/liveblocks-react-tiptap"
    description="@liveblocks/react-tiptap"
    visual={<DocsTiptapIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="React BlockNote"
    href="/docs/api-reference/liveblocks-react-blocknote"
    description="@liveblocks/react-blocknote"
    visual={
      <DocsBlocknotejsIcon className="fill-product-icon-brand h-auto w-6" />
    }
  />
  <DocsCard
    type="technology"
    title="React Lexical"
    href="/docs/api-reference/liveblocks-react-lexical"
    description="@liveblocks/react-lexical"
    visual={<DocsLexicalIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="Redux"
    href="/docs/api-reference/liveblocks-redux"
    description="@liveblocks/redux"
    visual={<DocsReduxIcon />}
  />
  <DocsCard
    type="technology"
    title="Zustand"
    href="/docs/api-reference/liveblocks-zustand"
    description="@liveblocks/zustand"
    visual={
      <img
        alt=""
        src="/assets/zustand.png"
        width={24}
        height={24}
        loading="lazy"
      />
    }
  />
  <DocsCard
    type="technology"
    title="Yjs"
    href="/docs/api-reference/liveblocks-yjs"
    description="@liveblocks/yjs"
    visual={<DocsYjsIcon className="fill-product-icon-brand h-auto w-6" />}
  />
</ListGrid>

## Server packages and APIs

<ListGrid columns={2}>
  <DocsCard
    type="technology"
    title="Node.js"
    href="/docs/api-reference/liveblocks-node"
    description="@liveblocks/node"
    visual={<DocsNodejsIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="Node.js ProseMirror"
    href="/docs/api-reference/liveblocks-node-prosemirror"
    description="@liveblocks/node-prosemirror"
    visual={<DocsNodejsIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="Node.js Lexical"
    href="/docs/api-reference/liveblocks-node-lexical"
    description="@liveblocks/node-lexical"
    visual={<DocsNodejsIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="Node.js Emails"
    href="/docs/api-reference/liveblocks-emails"
    description="@liveblocks/emails"
    visual={<DocsNodejsIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="Chat SDK adapter"
    href="/docs/api-reference/liveblocks-chat-sdk-adapter"
    description="@liveblocks/chat-sdk-adapter"
    visual={<DocsRobotIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="Python"
    href="/docs/api-reference/liveblocks-python"
    description="Python SDK"
    visual={<DocsPythonIcon />}
  />
  <DocsCard
    type="technology"
    title="REST API"
    href="/docs/api-reference/rest-api-endpoints"
    description="HTTP endpoints"
    visual={<DocsApiIcon className="fill-product-icon-brand h-auto w-6" />}
  />
  <DocsCard
    type="technology"
    title="Webhook events"
    href="/docs/api-reference/webhook-events"
    description="Event schemas and examples"
    visual={<DocsApiIcon className="fill-product-icon-brand h-auto w-6" />}
  />
</ListGrid>

---

For an overview of all available documentation, see [/llms.txt](/llms.txt).
