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

Actions

Testing and publishing

Move from a saved draft to an enabled action with a verified customer workflow.

Overview

A draft stores your configuration. Enabling publishes the action for the selected channels. Complete the checks for your action type before enabling, then verify the result from the customer's channel.

Before enabling

Action typeRequirements to review
Call APIValid inputs and request, a passing test for the current request, response access, and supported channels.
Run client-side codeInput descriptions, the exact host registration, the website setup acknowledgment, and browser channels.
Call API + show widgetAPI requirements plus a linked widget and valid data bindings.
Show widgetA linked widget, any necessary inputs, supported channels, and valid automatic rules if used.

Run an API test

  1. Save the request configuration you intend to use.
  2. Open Test and supply representative values for the inputs.
  3. Run the test and review its final status and response.
  4. Resolve authentication, request, or response problems and repeat the test.
  5. Select the fields the AI may read in Data access.

A successful test is tied to the request configuration. If the editor asks you to retest after a change, do so before enabling. Example JSON is a configuration aid, not proof that the endpoint responds successfully.

Enable the action

Use Save & enable after completing the required sections. If QwryAI asks for an approval policy for a write action, select a published policy that applies to the operation. Resolve any field or test errors and confirm the action's enabled state in My actions.

An enabled action
After Save & enable, My actions shows Read current page as Live on one channel.

Test as a customer

ScenarioExpected check
Matching requestThe agent selects the intended action and shows the correct result.
Missing required inputThe conversation obtains the needed information before proceeding.
Unrelated requestThe action does not take over an unrelated conversation.
Unavailable service or failed handlerThe customer receives a useful failure or next step without a false success claim.
Client actionThe registered function runs on your embedded test page and returns data.
Widget actionThe card shows the right values and its interactions work.
Automatic widgetConditions, display limits, dismissal, and placement behave as configured.
Disabled actionA new matching conversation no longer uses the disabled action.

Troubleshooting

ProblemNext step
Save & enable is blockedReview all required fields, selected channels, website acknowledgment, widget association, and API test status.
Behavior policy must compile before publishingSave the draft and reopen it after processing. If the error remains, contact support with the action name and the displayed error. A saved draft is not enabled.
The AI does not select the actionCheck that it is enabled on this channel and give When to use a precise, relevant instruction.
The API responds but the AI lacks dataReview Full or Limited access and the selected response fields.
The widget is emptyCompare its input schema with the latest test response and bindings.
An automatic widget does not reappearCheck first-visit rules, total and per-visit caps, and dismissal state.