Get set up in minutes
Install
Sign in with Google and your site is created for you. On its Settings page, 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 your pages, once your button and form map is made. |
| 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. |
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
From your website
On the Settings page, Scan my website reads your public pages into one knowledge document in seconds. It also runs when you save a new website address. Map buttons and forms opens your website in a browser, finds what a visitor can click and fill, and builds the map browser assist runs on, which goes live as soon as it's ready. Each can be run once an hour.
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.
Console
The Console page lists every open page with the assistant on it. Pick one, type a call such as openPage("pricing") and see the result and a live screenshot.
Portal API
Everything the portal shows is available as JSON under /api/crm. Scripts send the owner's portal token as Authorization: Bearer TOKEN.
| Endpoint | Purpose |
|---|---|
GET /api/crm/dashboard | Totals, 14-day series, top questions |
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 |
POST /api/crm/sites/:id/scan, GET POST /api/crm/sites/:id/map | Read your website into knowledge; draft a button and form map |
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 |