Knowledge base (FAQs)
list_faqs read
Section titled “list_faqs ”List the restaurant’s knowledge-base entries (FAQs) — what the AI can answer about hours, policies, parking, etc. Returns each entry’s id, title, a snippet, whether it’s active, and its processing status. Use before editing/removing an entry, or to check what the AI knows.
Required scope: knowledge.read
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
add_faq write
Section titled “add_faq ”Add a knowledge-base entry so the AI can answer it. Use when an owner tells you a fact/policy the AI should know — e.g. ‘add an FAQ: we don’t take parties larger than 12’ or ‘let people know we validate parking’. Pass the fact as `content`; an optional short `title` labels it. The entry is processed in the background (searchable within a few seconds).
Required scope: knowledge.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
content |
string | yes | The fact/policy/answer the AI should know, in plain language. |
title |
string | no | Optional short label for the entry (defaults to the first line of content). |
idempotencyKey |
string | no |
set_faq_active write
Section titled “set_faq_active ”Turn a knowledge-base entry on or off. Use when an owner says ‘stop the AI mentioning our old happy-hour’ (active:false) or ‘turn that FAQ back on’. `faqId` comes from list_faqs.
Required scope: knowledge.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
faqId |
string | yes | FAQ id (from list_faqs). |
active |
boolean | yes | true = the AI can use it; false = disabled. |
idempotencyKey |
string | no |
delete_faq write
Section titled “delete_faq ”Permanently remove a knowledge-base entry. Use when an owner says ‘delete that FAQ’. `faqId` comes from list_faqs. To just hide it, use set_faq_active with active:false instead.
Required scope: knowledge.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
faqId |
string | yes | FAQ id (from list_faqs). |
idempotencyKey |
string | no |