Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.warpy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Warpy docs

​
Set up Warpy in the right order.

Warpy lets an embedded widget answer from documents, call the APIs you configure, run frontend handlers you expose, act on the page, and render dynamic output UI. Start with API config, embed the widget, then add tools.

Call configured endpoints from the user’s browser with session headers attached.
Trigger host-side handlers with window.warpy(name, vars).
Act on the page when a manual tool does not exist.
Ground answers in product docs, SOPs, policy docs, or university content.
Render markdown, responsive Warpy components, or your own native components.

New accounts start with a short onboarding flow that seeds the website, production API base URL, auth setup, enables the knowledge base when you add that first website, and gives you the first install snippet before the full dashboard.

​
Setup order

1

Add base URLs, auth settings, and any custom headers first.

2

Install the widget and configure the user-facing behavior.

3

Define what the agent may do and group tools into features.

4

Upload documents for grounded answers.

​
Runtime model

End user
   |
Embedded widget
   |
Warpy orchestration
   |-- Backend tool
   |-- Frontend tool
   |-- Screen autopilot
   |-- Knowledge base
   |
Action or answer
   |
End user

​
Core guides

Quickstart

Launch in the right order and avoid the common setup mistakes.

API config

Configure base URLs, auth settings, and custom headers.

Features and tools

Add backend tools, frontend tools, and feature-level controls.

Knowledge base

Upload product or university documents for grounded answers.

Activate agent

Install the widget and configure the runtime behavior.

Runtime flow

See the full request path between the widget, your app, and Warpy.

If base URLs, auth headers, or storage keys are wrong, the rest of the setup will look broken even when the tools are defined correctly.