Get set up in minutes
Install
Create a site in the portal, open its page and copy the script tag. Paste it before </body> on every page where the assistant should appear.
<script src="https://YOUR-RELAY/sdk/embed.js" data-id="your-site-id"></script>The data-id is the site's id from the portal. The assistant's widget appears in the corner of the page.
Configure a site
| Setting | What it does |
|---|---|
| Instructions | Who you are, your tone and what it must never do. Added to every prompt. |
| Greeting | The line under the assistant's title in the widget. |
| Browser filling | Lets the assistant click and type on pages that define page commands. |
| Company Q&A | Answers from the knowledge base, and admits when it has no answer. |
| General chat | Lets it chat beyond your documents. Off by default. |
| Lead capture | Lets it save a visitor's contact details to your contacts. |
Changes take effect on the next question.
Knowledge base
Add documents on the Knowledge page by pasting text or uploading a .txt, .md, .csv or .json file. Separate topics with a blank line: each paragraph is searched on its own, and the best matches are given to the assistant with each question.
- Write in plain sentences, like the answers you would give in person
- Put prices, hours and policies in their own paragraphs
- Use the search box on the site page to check what the assistant would find
Sessions and logs
A session starts when a visitor opens a page with the assistant. The log lists pages visited, each question and answer, and every action the assistant took. Delete a log from its detail view.
Contacts
Leads collected by the assistant, the website contact form or added by hand appear on a board with the stages lead, contacted, qualified, won and lost. Open a contact to edit details, add notes or jump to the conversation that produced it.
Console
The Console page lists every open page with the assistant on it. Pick one, type a call such as selectTier(1) and see the result and a live screenshot.
Portal API
Everything the portal shows is available as JSON under /api/crm. If the relay has PORTAL_TOKEN set, send it as Authorization: Bearer TOKEN.
| Endpoint | Purpose |
|---|---|
GET /api/crm/dashboard | Totals, 14-day series, top questions, pipeline |
GET POST /api/crm/sites, PUT DELETE /api/crm/sites/:id | Sites and their configuration |
GET POST /api/crm/docs, DELETE /api/crm/docs/:id | Knowledge documents |
GET /api/crm/search?site=&q= | Try a question against the knowledge base |
GET /api/crm/sessions, GET DELETE /api/crm/sessions/:id | Session list and logs |
GET POST /api/crm/contacts, PUT DELETE /api/crm/contacts/:id | Contacts and pipeline stage |