Text Platform Python API Docs | dltHub
Build a Text Platform-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Text Platform Chat Widget API is a JavaScript API that allows interaction with the Chat Widget embedded on a website. The REST API base URL is There is no documented public REST API base URL for the Text Platform Chat Widget; the widget script is loaded from https://cdn.livechatinc.com/tracking.js. and All requests require a license number for authentication..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Text Platform data in under 10 minutes.
What data can I load from Text Platform?
Here are some of the endpoints you can load from Text Platform:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| state | get("state") | GET | Returns the current state of the chat widget, including availability and visibility. | |
| customer_data | get("customer_data") | GET | Returns customer-related data such as ID, name, email, and session variables. | |
| chat_data | get("chat_data") | GET | Returns chat-specific data like chat ID and thread ID. |
How do I authenticate with the Text Platform API?
Authentication for the Chat Widget JavaScript API uses a license number (window.__lc.license = <LICENSE_NUMBER>) embedded in the JavaScript snippet to identify the account. There is no bearer/API-key REST authentication documented for this widget API.
1. Get your credentials
To obtain API credentials, find the code snippet in the LiveChat app or copy it from the documentation, then replace <LICENSE_NUMBER> with your specific license number.
2. Add them to .dlt/secrets.toml
[sources.text_platform_source] license_number = "YOUR_LICENSE_NUMBER"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Text Platform API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python text_platform_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline text_platform_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset text_platform_data The duckdb destination used duckdb:/text_platform.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline text_platform_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads customer_data and chat_data from the Text Platform API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def text_platform_source(license_number=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "There is no documented public REST API base URL for the Text Platform Chat Widget; the widget script is loaded from https://cdn.livechatinc.com/tracking.js.", "auth": { "type": "api_key", "license_number": license_number, }, }, "resources": [ {"name": "customer_data", "endpoint": {"path": "get("customer_data")"}}, {"name": "chat_data", "endpoint": {"path": "get("chat_data")"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="text_platform_pipeline", destination="duckdb", dataset_name="text_platform_data", ) load_info = pipeline.run(text_platform_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("text_platform_pipeline").dataset() sessions_df = data.customer_data.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM text_platform_data.customer_data LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("text_platform_pipeline").dataset() data.customer_data.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Text Platform data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Troubleshooting
API Initialization Errors
If you attempt to use getters before the Chat Widget JavaScript API has fully loaded, you will encounter errors such as "You can't use getters before load." To prevent this, ensure asynchronous initialization by setting __lc.asyncInit = true and calling LiveChatWidget.init(). Utilize on, once, or ready callbacks to wait for the widget to be fully ready before making API calls.
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Text Platform?
Request dlt skills, commands, AGENT.md files, and AI-native context.