Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yourhomie.ai/llms.txt

Use this file to discover all available pages before exploring further.

This page documents the client-side Browser API exposed by the embed script. For server-side REST endpoints, see your API Reference.

​
Overview

Once the Homie embed script is loaded, a global object window.homieBot becomes available. Use it to open/close the widget, check its state, send messages programmatically, and read the chat history.

​
Requirements

  1. The script must be embedded on your page.
  2. chatbotId and domain must be set.
  3. storeId is optional and can be passed when needed.
<script
  src="https://chat.yourhomie.ai/embed.min.js"
  chatbotId="YOUR-CHATBOT-ID"
  domain="https://chat.yourhomie.ai"
  storeId="your-store-id"
  defer
></script>
The object window.homieBot is only available after the script has loaded. Listen for the homiebot:api-ready event to be notified when the API is ready, or use the waitForHomie() fallback in the examples section.

​
Browser events

The embed dispatches custom browser events on window so you can hook into lifecycle and interaction without polling:
EventWhen
homiebot:api-readywindow.homieBot is available
homiebot:assistant-readyChat iframe is loaded; sendMessage / getHistory work
homiebot:openedChat widget was opened
homiebot:closedChat widget was closed
Each event includes { chatbotId } in event.detail. See the examples page for listener snippets.

​
TL;DR

MethodPurpose
open()Open the chat
close()Close the chat
toggle()Toggle open/closed
isOpen()Read current state
sendMessage(input, options?)Inject a message (with retry/timeout)
getHistory()Read the current history
updateMessageMetadata(metadata)Add metadata to the next user message