Skip to Content
DocumentationIntroduction

What Oshara gives you

A configured AI voice agent that runs on Oshara’s infrastructure. You connect to it through one of two integration paths:

PathWhat you doBest for
WidgetAdd a one-line <script> tag to your siteAny website that wants a floating “Talk to us” button
APICall REST endpoints from your backendNative apps, custom UIs, server-issued sessions, agent-filled forms

Both paths use the same backend at https://api.oshara.ai.

What you can integrate

Widget integration

  • Embed the widget on any HTML page — floating voice button, mic, live transcript (Quickstart)
  • Brand the widget — colors, logo, FAB label, panel size (Appearance)

API integration

  • Start sessions from your backend — inject user context, keep credentials server-side (Sessions)
  • Noise cancellation — Krisp or DeepFilterNet3, configured per character or in a custom UI (Noise Cancellation)
  • Form handling — define forms, receive submissions at your endpoint, fetch from managed storage (Form Handling)
  • Dynamic form control by voice — agent opens, reads, and submits forms in real time over the data channel (Voice Form Control)
  • Pre-fill forms via API — defaults, session metadata, conversation context, or direct injection (Form Pre-fill)
  • Connect your APIs as agent tools — endpoints the agent can call mid-conversation (Agent Tools)

Architecture

┌─────────────────────────────────────────────────────────────────┐
│  Your website / app                                             │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────┐   │
│  │  Oshara Widget (script tag)   OR   Your custom UI       │   │
│  │  • Mic / speaker UI                • LiveKit SDK         │   │
│  │  • Live transcript                 • Your form renderer  │   │
│  │  • Noise cancellation              • Your branding       │   │
│  │  • Agent-driven forms                                    │   │
│  └───────────────────────┬─────────────────────────────────┘   │
└──────────────────────────┼──────────────────────────────────────┘
                           │ WebRTC + Data Channel
                           ▼
┌──────────────────────────────────────────────────┐
│  Oshara backend (https://api.oshara.ai)          │
│  • Session tokens   • Appearance + form schema   │
│  • Form responses   • Character management       │
└──────────────────────────────────────────────────┘

Base URL

https://api.oshara.ai

The widget script is served from:

https://api.oshara.ai/widget.js

Where to start

Last updated on
Quickstart