get_vilix_guide
In-chat Vilix help. Call this when the user asks what Vilix is, how
to connect a specific AI tool, how to use Vilix day to day, or about
the discount / creator offer — and relay the returned text (it's
written to be read to the user). The agent is the main onboarding
surface, so prefer answering here over sending the user to a website.
Returns one topic's short, chat-sized answer with a plain-text text
you can always read out, plus structured fields a guide-card UI can
render: relevant assets (connect/demo links), tools (connectable
tools), and the creator-offer state. For "how do I make this
automatic" the answer points you at the get_setup_instructions tool —
call that for the exact paste-in block.
topic (optional) — what the user is asking about: "overview" (what
Vilix is / how to use it, the default), "connect", "using_daily",
"make_it_automatic", or "offer" (the creator discount). Free-form labels
are accepted and mapped.
tool (optional) — the AI tool the question is about (e.g. "ChatGPT",
"Cursor"), to scope connect / asset links.
viewed (optional) — log a downstream interaction with what you
surfaced: "asset_viewed" when the user opens a demo link, or
"custom_instructions_copied". Omit otherwise.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tool | No | ||
| topic | No | ||
| viewed | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | ||
| error | No | ||
| offer | No | ||
| title | No | ||
| tools | No | ||
| topic | No | ||
| assets | No | ||
| topics | No | ||
| message | No | ||
| see_tool | No | ||
| upgrade_url | No |