Demo App

A working TypeScript demo that exercises all API flows.

A complete TypeScript demo application is included in the repository at docs/demo/headless-chat-demo/.

Setup

cd docs/demo/headless-chat-demo
npm install

Run

Run all flows

API_KEY=api_your_key npm start

Run individual flows

API_KEY=api_your_key npm run flow1   # New conversation
API_KEY=api_your_key npm run flow2   # Resume conversation

What It Does

Flow 1: New Conversation

Lists all agents
Creates a new session
Sends a question
Receives the AI response
Shows follow-up suggestions

Flow 2: Resume Conversation

Lists existing sessions for the agent
Loads the most recent session with message history
Displays previous messages
Sends a follow-up question
Receives the AI response

Environment Variables

Variable	Required	Description
`API_KEY`	Yes	Your organisation API key
`API_BASE_URL`	No	API base URL (defaults to `http://localhost:3002`)
`AGENT_ID`	No	Specific agent ID (defaults to first agent found)

Source Code

The demo is structured as:

src/api-client.ts — Reusable API client class
src/flow1-new-conversation.ts — New conversation flow
src/flow2-resume-conversation.ts — Resume conversation flow
src/index.ts — Runs both flows

You can use the ApiClient class as a starting point for your own integration.

Postman Collection

Test the API using the provided Postman collection.

Embedded Widget vs Headless API

Understanding the differences between the two integration approaches.