Docs

Everything to get a concierge live: embed the widget, or call the /v1 API directly. The fastest path is the dashboard — create an assistant, grab a publishable key, copy the snippet.

Quickstart

  1. Sign up and run the onboarding wizard to create your first bot.
  2. Add knowledge (upload docs, run a sync) so it answers from your content.
  3. Copy the widget snippet, or call the API with the publishable key.

Embed the widget

<script
  src="https://cdn.rozoomi.dev/widget/v1/rozoomi.js"
  data-key="rzk_pk_your_publishable_key"
  data-api="https://api.rozoomi.dev"
  defer
></script>

React/Vue wrappers and host-platform recipes (WordPress, Shopify, Magento, Salesforce, Storefront Next) live under Integrations.

Auth & keys

  • rzk_pk_ publishable — browser/widget safe; /v1/chat + SSE.
  • rzk_sk_ secret — server only; /v1/lead, /v1/ingest.
  • x-admin-key admin — server only; /v1/admin/*.

API reference

Generated from the typed contract (@rozoomi/sdk). The canonical OpenAPI spec is published from the backend at docs/rozoomi.public.yaml.

MethodPathAuthDescription
POST/v1/chatrzk_pk_ (publishable)One conversational turn. Returns answer, intent, quote, captureLead.
GET/v1/chat (SSE)rzk_pk_Token-by-token streaming of a turn.
POST/v1/leadrzk_sk_ (secret)Persist a captured lead + fire attribution.
POST/v1/ingestrzk_sk_Presigned upload (op=upload) / start sync (op=sync).
POST/v1/admin/botsx-admin-keyCreate a bot (persona, origins, plan).
POST/v1/admin/keysx-admin-keyMint a publishable/secret key (shown once).
DELETE/v1/admin/clients/{id}x-admin-keyGDPR right-to-erasure for a tenant.