Documentation

Everything you need to build with Orac

Step-by-step guides, API reference, and platform-specific integration documentation.

Quick Start

Live chatbot in 3 lines of code

Add to any page
<!-- Step 1: Add this before </body> -->
<script
  src="https://askorac.com/widget.js"
  data-orac-id="YOUR_PROJECT_ID"
></script>

<!-- That's it. Your chatbot is live. -->

Guides

Getting Started

Create your account, set up your first project, and deploy a chatbot in under 5 minutes.

Create an account
Create a project
Add your first source
Embed the widget
Customize appearance

Training Sources

Upload files, paste URLs, or crawl your entire site. Learn how auto-sync keeps content current.

File upload (PDF, DOCX, TXT)
Single URL import
Full site crawl
Sitemap configuration
Auto-sync & content hashing

Widget Integration

Script tag, npm package, or REST API — detailed implementation guides for every method.

Script tag (universal)
React / Next.js package
REST API endpoints
Custom event hooks
Testing & debugging

Customization

Colors, branding, welcome message, fallback behavior, and behavioral instructions.

Widget theming
Position & layout
Welcome message & avatar
Custom instructions
Fallback configuration

Custom Actions

Define webhook endpoints Orac calls mid-conversation. Built-in calculator, CSV query, and multi-step chains.

Creating actions
Webhook format
Multi-step chains
Visitor authentication
Industry templates

Security & Privacy

Data isolation, encryption architecture, and compliance documentation.

Row-level security
Encryption in transit & at rest
BYOK key encryption
Data retention policies
GDPR & data rights

Intelligence & Analytics

Knowledge gap analysis, confidence scoring, frustration detection, and weekly digest reports.

Intelligence dashboard
Knowledge gap detection
Confidence scoring
Frustration detection
Weekly digest emails

Webhooks & Real-time Sync

CMS integration, real-time content updates, and webhook configuration.

Webhook endpoint setup
WordPress integration
Shopify integration
Webflow integration
Sync history & monitoring

Human Handoff & Self-Healing

Escalation rules, owner reply, and knowledge self-healing from the dashboard.

Escalation triggers
Email notifications
Replying from dashboard
Knowledge self-healing
Adding answers to gaps

API Reference

REST API v1
POST/api/v1/chat
GET/api/v1/projects
POST/api/v1/projects/:id/sources
POST/api/v1/projects/:id/crawl
GET/api/v1/projects/:id/conversations
GET/api/v1/projects/:id/analytics
GET/api/v1/projects/:id/intelligence
POST/api/v1/webhook/sync
GET/api/v1/conversations/export
POST/api/v1/knowledge
GET/api/v1/usage
POST/api/v1/webhooks/outbound
POST/api/v1/conversations/notes
POST/api/v1/conversations/reply
POST/api/v1/conversations/tags
GET/api/v1/search
POST/api/v1/sources/bulk

Platform Integration Guides

WordPress

Paste the script tag into your theme's footer or use a header/footer plugin like Insert Headers and Footers.

Shopify

Add the script tag to your theme.liquid file before the closing </body> tag via Online Store > Themes > Edit Code.

Webflow

Paste in Project Settings > Custom Code > Footer Code. The widget loads on all pages automatically.

Next.js

Install the @askorac/react package and add the <OracWidget /> component to your root layout.

React

Use the npm package for React apps, or the script tag in your public/index.html for Create React App.

HTML

Add one script tag before </body>. Works with any static site, PHP, Ruby, or server-rendered HTML.

0+
Messages free
0
AI models
0min
Setup time

Ready to let your docs do the talking?

Start free. No credit card required. Your first chatbot is live in under 5 minutes.

Start FreeSee How It Works