Documentation

Knowledge and capabilities

The Intelligence tab is where you give an assistant things it does not know by default: your own documents, the ability to work with the page it is embedded on, and connections to your own systems. Each capability is a card — turn it on with its switch, then expand it to configure. Only one card stays open at a time.

The Intelligence tab of the assistant editor, showing the Knowledge Base and Page Intelligence cards under a Knowledge heading and the Forms and Actions cards under Engagement

The cards sit under two headings: Knowledge (Knowledge Base, Page Intelligence) and Engagement (Forms, Actions — plus Appointment Scheduling on self-hosted enterprise deployments).

Changes to the switches on this tab are saved with the editor's Save button. Documents, forms and actions are saved as you add them — they do not wait for Save.

Knowledge Base

Paid feature. Add credits to your account to unlock it. On a free account the switch carries a PAID badge and refuses to turn on.

Upload files so the assistant can answer from your own content instead of guessing. Turn on the Knowledge Base switch, then expand the card to manage documents.

Uploading documents

Drop files onto the upload area or click it to browse. Supported types are PDF, DOCX, TXT, MD, HTML, and each file must be 10 MB or smaller. You can select several files at once.

A file is checked against its real contents, not just its extension — a file renamed to .pdf that is not a PDF is rejected. Uploading a file that matches an existing document's name and size returns the document you already have instead of creating a duplicate.

The document table

Every uploaded file appears in a table:

Column What it shows
Document The file name, with its size underneath
Status Where the file is in processing
Chunks How many passages the file was split into
— A delete button on the right of each row

Status moves through these values:

Status Meaning
pending Uploaded, waiting to be processed
processing Text is being extracted and indexed
indexed Ready — the assistant can retrieve from it
error Processing failed; the file is not searchable

Indexing runs in the background and takes a moment. Reopen the card or reload the page to see the status change.

Only documents with the indexed status are searched. A file sitting at error is ignored entirely.

There is no in-place edit. To update a document, delete the old row and upload the new version.

Note

Each assistant can hold 20 knowledge documents on a paid account. Uploading past the limit fails — on a free account with a message telling you to add credits, on a paid account with Each assistant can hold up to 20 knowledge documents during beta.

How retrieval changes answers

When the knowledge base is on, each visitor message triggers a search over the indexed passages of that assistant's documents. The most relevant passages — up to five, and only those scoring above a relevance threshold — are handed to the model alongside your instructions before it writes a reply.

Three consequences worth knowing:

  • Nothing relevant, nothing added. If no passage clears the threshold, the assistant answers from its instructions alone. Uploading a document does not force it to be mentioned.
  • Small talk skips the search. Greetings, thanks and other pleasantries are not searched, so the assistant will not ground "hi" in your price list.
  • Grounded replies are marked. When an answer used your documents, the visitor's chat window shows a Referenced knowledge base marker under that message.

Writing good source documents

Retrieval works on passages, not whole files: each document is split into overlapping chunks and the search matches a chunk at a time. Documents that read well in isolation retrieve well.

  • Keep one topic per section and give each section a heading, so a chunk that gets retrieved carries enough context to stand alone.
  • Keep a question and its answer close together. An FAQ where answers are three pages from their questions retrieves badly.
  • Use text-based files. A scanned PDF that is really a picture of a page has no extractable text and will index as empty.
  • Spell out what you mean rather than relying on a table layout or a diagram — layout is flattened to text during processing.
  • Remove superseded content instead of leaving it alongside the new version. The search cannot tell which of two contradictory passages is current.

Page Intelligence

Paid feature. Add credits to your account to unlock it. Saving an assistant with Page Intelligence on is rejected on a free account.

Page Intelligence lets the assistant work with the page it is embedded on, rather than only talking about it. Turn on the Page Intelligence switch, then expand the card for three individual permissions. All three are on by default; turn off any you do not want to grant.

Permission What it allows
Read Page Content The assistant reads the current page so it can answer in context.
Write & Click The assistant fills fields and clicks elements on the page.
Navigate Between Pages The assistant moves the visitor between pages of your site.

Turning off the master switch removes all three capabilities regardless of the individual settings.

If your site declares its own tools in code, those are controlled by the page itself and are covered in Page tools.

Forms

A form is the set of details the assistant collects in the conversation — contact details, an order, a request. The Forms card owns them outright: forms are not edited from the Actions card below, and the trigger picker there does not offer them.

The card header badges how many forms are live (2 live, or Paused when every form is switched off). Expand it for the list, then New form or a row to open the builder.

Building a form

Control Notes
Form name Required. The visitor sees it as the panel title.
The assistant calls present_form("<slug>"). The slug is minted from the name when you create the form, then fixed.
When the assistant should use it Read by the assistant when it picks between forms.
Fields Up to 40. Each row has a Label, a Type, a Required switch, and — behind the row menu — its field key and type-specific options.
How it's collected Show the form opens the panel so the visitor checks the details before submitting; Submit for them sends what the conversation already gathered, with no panel. The ? beside the heading opens a live preview of both.
Where submissions go Your inbox delivers through this assistant's escalation channels; Your server POSTs to your own endpoint, signed with the form's secret.

Field types are Short text, Email, Phone, Number, Date, Long text, Dropdown (with its own option list) and Hidden value (a fixed value sent with every submission, which the visitor never sees).

Warning

A form needs at least one destination. With both Your inbox and Your server off, the builder says Submissions have nowhere to go — and a submission fails rather than being silently dropped. Your inbox also needs an escalation channel to exist; add one on the Channels tab, or the card warns you there is no inbox set up.

Actions

Actions connect the assistant to your own systems. Each one sends an HMAC-signed HTTP request to an endpoint you control. Expand the Actions card to see the list, or New action to create one.

The two triggers

You choose the trigger when you create an action, and it cannot be changed afterwards. Create a new action if you need a different trigger.

Trigger On screen Fires when
ai AI-decided The assistant decides to call it mid-conversation, based on your description.
event Event Something happens on the platform — a conversation ends, a contact is created, a call completes.

Forms are the third trigger type in the API (form), but they are built in the Forms card above, so they neither appear in this list nor in its trigger picker.

Creating an action

The New action dialog, showing the trigger picker, name, endpoint method and URL fields, and the Enabled switch

The dialog shows the fields that matter for the trigger you picked:

Field Applies to Notes
When should this fire? New actions only The two trigger cards above. Hidden when editing.
Name All Required. Shown in the table and used to derive the action's identifier.
Description AI-decided Required, at least 10 characters. This is what the assistant reads to decide when to call the action, so describe the job, not the plumbing.
Events Event Required. Pick one or more from the list; the action fires whenever any selected event occurs.
Method All POST, GET, PUT, PATCH or DELETE.
Endpoint URL All Required. Must be an https:// address you control.
Enabled All Off means the action stays configured but never fires.

Finish with Create action, or Update action when editing.

The actions list

Column What it shows
Name The action name — click it to edit. Event actions list their selected events underneath.
Trigger ai or event.
Endpoint The method and URL the request goes to.
Status Enabled or Disabled.
Actions Test, edit and delete.

Test sends a real signed request to your endpoint immediately, so point it at something you are happy to hit. The result appears as a toast with the HTTP status your endpoint returned, or the error if the request could not be completed. Event actions are tested with a test.ping payload.

Deleting asks for confirmation first — the endpoint stops receiving requests and the action cannot be recovered.

Note

An organization can have up to 50 actions in total.

For the request format, the signature header and how to verify it, the full event list, and the delivery rules, see Actions.