BETA RELEASE — NOT FOR PRODUCTION USE

This document describes a beta version of the Headless SDK. It is provided for early evaluation purposes only.

  • This release is unofficial and has not undergone formal testing or QA.
  • It may contain bugs, errors, or incomplete/inaccurate information.
  • APIs, features, and behavior are subject to change without notice.
  • Do not deploy or rely on this in production environments.

Document Status: Active / Released
Author: LivePerson Developer Relations
Date: July 30, 2026
SDK Version: V0.3.4-beta.0
Changelog: See the Changelog guide in this docs site (listed under Guides in the sidebar) for the full, verified release history.

Table of Contents

  1. Repository Setup and SDK Installation
  2. Viewing the Documentation
  3. Running the Demo Application

1. Repository Setup and SDK Installation

Prerequisites

  • Node.js: Minimum version 24 is required.
  • Authentication: You will need an NPM_TOKEN to access the LivePerson private GitLab registry. This token will be distributed to you separately.

Step 1: Initialize Your Node Project

If you do not already have a project repository set up, create a new directory and initialize a Node project:

mkdir lp-headless-sdk
cd lp-headless-sdk
npm init -y

Step 2: Configure the .npmrc File

To securely pull the SDK from the LivePerson registry, create an .npmrc file in the root of your project repository. Add the following configuration to the file, ensuring you replace `` with the actual token you received:

@liveperson:registry=https://gitlab.com/api/v4/projects/82846725/packages/npm/
//gitlab.com/api/v4/projects/82846725/packages/npm/:_authToken=

Step 3: Install the SDK

Once the project is initialized and the registry is configured, install the latest version of the Headless SDK:

npm install @liveperson/headless-sdk@beta

Step 4: Verify Installation

To confirm the SDK was installed successfully, navigate to the newly created package directory:

cd node_modules/@liveperson/headless-sdk

Verify that the following directory structure and files are present:

dist/
├── docs/
├── index.d.ts
├── index.js
└── lp-messaging-client-sdk.js
examples/
└── demo-agent/

2. Viewing the Documentation

The complete API documentation and integration guides are bundled directly within the SDK package. Once installed, you can serve these files locally.

Step 1: Start the Local Web Server

From the root directory of your project, run the following command to serve the documentation using npx:

npx serve node_modules/@liveperson/headless-sdk/dist/docs

Step 2: Access the Documentation

The command above will start a local web server and output a localhost URL (typically http://localhost:3000). Open that URL in your preferred web browser to view the documentation home page.

Step 3: Navigating the Docs

From the home page:

  • Click on Overview to get started with the basics of the SDK.
  • Click on API Reference for detailed, technical information about the specific methods and events offered.

3. Running the Demo Application

The SDK includes a built-in demo application to help you see the client in action.

Step 1: Extract the Demo Application

From the root of your project, copy the demo-agent folder out of the node_modules directory into your project root, and copy over your .npmrc file:

cp -r node_modules/@liveperson/headless-sdk/examples/demo-agent ./demo-agent
cp .npmrc demo-agent/

Step 2: Install Demo Dependencies

Navigate into the newly copied demo directory and install the necessary packages:

cd demo-agent
npm install

Step 3: Start the Demo

Once the installation is complete, start the development server:

npm run dev

⚠️ IMPORTANT: Check your terminal output to verify the application is running on port 5173. If the server starts on any other port, the application will not function correctly.

Step 4: Launch the Application

Open your web browser and navigate to the following URL to view and interact with the demo: http://localhost:5173/