Overview
Lookup material for the docs: the glossary, the roles and permissions matrix, supported channels, knowledge source types and limits, and agent and session status references.
Glossary
Definitions of the terms used across the portal and these docs, grouped by area, with links to the pages where each concept is explained.
Roles and permissions
Lookup matrix for the four user roles: which menu sections each role sees and which actions each role can perform in the portal.
Supported Channels
Catalog of all supported channels - web widget, messaging, email, and voice - with connection statuses and channel-sharing rules.
Knowledge Source Types
Lookup tables for the five knowledge source types: accepted formats, size limits, indexing statuses, and common limit errors.
Agent Statuses
What each of the six agent statuses means, which action is available in each, and how to recover an agent from Error.
Session Statuses
Every final status a session can receive, what each one means, and how statuses group into campaign communication outcomes.
Campaign statuses
What each campaign status means on the Flows and Python screens, how a campaign reaches it, and what to do next.
Flow nodes
Field reference for every campaign flow node: the six triggers, the Field Check condition with its operators, and the eight actions, with each node's settings and required fields.
Conversation result field types
Reference for the field_type values in a conversation result definition: text, number, boolean, date, list, and fixed-choice fields, with what each captures and where the value appears.
Widget configuration
Developer reference for the embeddable chat widget: every initialization parameter, the control methods, custom events and message listeners, and the browser storage keys.
LLM and model settings
Reference for the model settings a portal user sets: the agent's Models card in Advanced mode and the language-model connection fields, with what each setting does and when to change it.
Environment variables
Reference for the environment variables an AI agent honors: greeting and prompt overrides, session timeouts, memory and summarization, knowledge search, language and speech, channel options, and logging.
YAML basics
A short primer on YAML syntax for portal users who edit a workflow, conversation result schema, or tool definition: indentation, keys, lists, nesting, quoting, comments, and common mistakes.
Troubleshooting
An index of common problems grouped by symptom, with links to the page that explains each fix.
FAQ
Short answers to common questions about agents, channels, knowledge, testing, campaigns, and handoff, each linking to the full page.
Tool configuration reference
The YAML definition file format for a tool group: top-level keys, how a tool is declared, the parameter schema and allowed types, how a skill is declared and when it runs, dependency bindings, and the built-in tools.
Deep Analysis YAML reference
Field reference for the Deep Analysis configuration YAML: scheduling rules, LLM-based and code-based metrics, and the visualization tabs and plots that build the dashboards.
Python campaign reference
Reference for code-based Python campaigns: campaign statuses, stage channel configuration, the three strategy types and the objects they receive, contact and communication fields, and the campaign result definition.
Legacy Knowledge Bases reference
Reference for the deprecated legacy Knowledge Base feature: where the attachment still appears, how it differs from Knowledge Sources, and why new agents use Knowledge Sources.