.Riyaan Docs
API Reference

API Reference

The Riyaan backend exposes HTTP endpoints via Convex. All endpoints accept either appSlug + appSecret (server-to-server) or a sessionToken (browser-safe) for authentication.

Browse endpoints by category in the sidebar, or jump to a section:

  • Auth — Session creation
  • Tokens — Ephemeral Gemini tokens
  • Agents — Runtime sessions, prompts, runs
  • Tools — Tool registration and execution
  • Guardrails — Safety rules and violation tracking
  • Knowledge — RAG documents, search, gaps
  • Conversations — Conversation lifecycle
  • Messages — Transcription persistence
  • Handoffs — Human handoff management
  • Persona — Agent identity and persona library
  • LiveKit — Room, token, and webhook management
  • Analytics — Insights, CSAT, clustering, ROI
  • Outcomes — Business event tracking
  • Alerts — Metric-based alert rules
  • Experiments — A/B test variants
  • QA — Scenario-based quality checks
  • Outbound — Event-triggered outbound messages
  • Annotations — Conversation quality annotations
  • Traces — Cross-table timeline
  • Scenario State — Demo state read/reset
  • Templates — Vertical template deployment
  • Events — Telemetry event ingestion
  • Dashboard — Next.js proxy routes
Edit on GitHub

Last updated on

On this page