API Documentation

Assisters.open()

Opens the chat widget programmatically.

Assisters.close()

Closes the chat widget.

Assisters.toggle()

Toggles the chat widget open/closed.

Assisters.sendMessage(message)

Sends a message programmatically.

Assisters.sendMessage("Hello, I need help with my order");

Assisters.isOpen()

Returns true if the chat widget is currently open.

Assisters.destroy()

Removes the widget from the page completely.

Send a message and receive a streaming response.

Headers

X-Assisters-Key: ask_your_api_key
Content-Type: application/json

Request Body

{
  "assisterId": "uuid",
  "message": "Hello, I need help",
  "sessionId": "optional-session-id"
}

Response

Returns a Server-Sent Events (SSE) stream with chunks of the response.

SSE Stream Format

// Each chunk arrives as a JSON event:
data: {"type":"chunk","content":"Hello"}

data: {"type":"chunk","content":", how"}

data: {"type":"chunk","content":" can I"}

data: {"type":"chunk","content":" help you today?"}

// Final event with metadata:
data: {"type":"done","tokens_used":142,"hideWatermark":false}

JavaScript Example

const response = await fetch('https://assisters.io/api/embed/chat', {
  method: 'POST',
  headers: {
    'X-Assisters-Key': 'ask_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    assisterId: 'your-assister-uuid',
    message: 'Hello!'
  })
});

const reader = response.body.getReader();
const decoder = new TextDecoder();
let fullText = '';

while (true) {
  const { done, value } = await reader.read();
  if (done) break;

  const text = decoder.decode(value);
  const lines = text.split('\n');

  for (const line of lines) {
    if (line.startsWith('data: ')) {
      const data = JSON.parse(line.slice(6));
      if (data.type === 'chunk') {
        fullText += data.content;
        console.log(data.content); // Stream to UI
      } else if (data.type === 'done') {
        console.log('Complete! Tokens:', data.tokens_used);
      }
    }
  }
}