Skip to content
QwryAI
Documentation

Explore the documentation

Quick StartWelcome to QwryAI

Get started with QwryAI and discover how to build an AI support assistant trained on your business data.

Quick StartBuild Your First AI Agent

Create a support agent from your website, review its knowledge, and publish it to your site.

Quick StartBest Practices

Use these practices to improve answer quality, reduce failed handoffs, and keep your chatbot useful over time.

Quick StartResponse Quality

Improve how accurately and helpfully your chatbot answers customers.

AI Agent ManagementPlayground

Test and optimize your chatbot before deployment.

AI Agent ManagementData Sources

Add, train, and maintain the knowledge your agent uses to answer customer questions.

AI Agent ManagementDeploy

Add your chatbot to a website or ecommerce storefront.

AI Agent ManagementSettings

Configure language, AI models, response behavior, and human support routing.

AI Agent ManagementEmail Settings

Configure email handoff and reply behavior for chatbot support workflows.

AI Agent ManagementLead Forms

Collect customer details directly inside the chat experience.

AI Agent ManagementIntegrations

Connect QwryAI with external platforms and business tools.

AI Agent ManagementDeveloper & Agent Access

Connect QwryAI to external AI tools, MCP clients, scripts, and CLI workflows.

AI Agent ManagementBackstage

Ask questions about your agent and workspace in a dedicated internal conversation.

AI Agent ManagementInstructions

Define your agent's behavior, guardrails, model, and response style.

AI Agent ManagementProcedures

Write a repeatable customer process with instructions, conditions, and actions.

AI Agent ManagementAction approvals

Review the exact input before an action performs a business write.

Pages

AI Agent Management

Widget Studio

Create reusable interfaces for action results and customer interactions.

Overview

Open Build → Widgets to manage the UI cards your agent can display. My widgets contains saved widgets; Create widgets offers starting points for a new design. A widget can be linked to an action and reused.

Reusable QwryAI website guide
The saved widget contains real website setup instructions and a link to QwryAI.

Create a widget

  1. Open Create widgets and choose a template or start a new widget.
  2. Use the builder to describe the interface, edit its content, and review the preview.
  3. Define the values the widget expects and configure its functions where needed.
  4. Check the card with representative data and each interactive state.
  5. Save the widget, then link it from a compatible action's Widget section.

Work in the builder

SurfaceUse it for
AI builderDescribe a new design or a change to the current widget.
PreviewInspect the resulting card and its interactions.
CodeEdit the widget implementation and its Schema, Default data, and named examples.
FunctionsConfigure the behavior connected to widget interactions.
StatesChoose when sections are visible, using data conditions and groups.

Configure widget functions

Function typeBehavior
Call APICall an API and use the returned data.
Run client-side codeInvoke a function implemented by the website host.
Send messageSend the configured message into the conversation on the visitor’s behalf.
Open linkOpen a URL, email client, or phone dialer.
Open embedded pageOpen an HTTPS page inside the web widget.
Dismiss widgetClose the widget.
Set variablesUpdate the widget’s state values.

Review the fields shown for the selected function type, including inputs, return fields, and On execute, On success, or On failure behavior where available. Link the function to the intended control and test its result from the deployed channel.

A widget link function
The Visit QwryAI button uses an Open link function with the real QwryAI website URL.

Control visibility with states

  1. Open States and choose Add your first state or Add state.
  2. Give the state a clear name and choose its Visibility.
  3. For conditional visibility, add the data conditions and combine them with And or Or. Use groups when conditions belong together.
  4. Review the Default data and named examples in Code so you can exercise each state.
  5. Check both matching and non-matching values in Preview, then save the widget.

States change which widget sections appear based on data. They are separate from action triggers, which determine when an entire widget action starts.

Check each preview surface

Use Widget, Chat bubble, and Agent page below the preview to inspect the card in its customer-facing context. Switch between light and dark preview themes and check the card’s buttons, long text, and conditional states before attaching it to an action.

Design for real data

  • Use consistent input names and types so action mappings remain understandable.
  • Provide useful empty, loading, success, and error states where the interaction needs them.
  • Check long text and missing optional values.
  • Test keyboard operation and a narrow mobile viewport.
  • Confirm that any function which changes business data follows the required action and approval workflow.

Reuse and manage widgets

Search My widgets to reopen an existing design. Use the widget's management controls to rename or manage it. When linking an existing widget to another action, review its input schema and all existing uses before editing the shared design.

Import and export

The Widget Studio options menu supports downloading and uploading widget JSON files. Uploads must be smaller than 2 MB and pass widget validation; save after upload to keep the change. The custom action's Widget section also supports a .widget file. Use this to reuse a design, then review its inputs and functions in the destination action before enabling it.