Skip to main content

Quickstart

Create an app​

Before you begin, create an app in the platform.

Install the chat widget​

The Plucky chat widget can be integrated into any website using the @plucky-ai/chat-sdk package.

npm install @plucky-ai/chat-sdk

Then, on the page you want to add chat to, copy the example code.

import { init } from '@plucky-ai/chat-sdk'

const api = init({
  appId: 'your-app-id',
  baseUrl: 'https://your-plucky-instance.com',
  mode: 'overlay', // or 'push'
  tools: [], // optional custom tools
})

// Open the chat widget
api.open()

// Send a message programmatically
api.sendMessage({
  content: 'Hello, how can I help?',
  createChat: true, // Will send the message in a new chat
})