What is Hiroi Assistant
Hiroi Assistant is an AI assistant you configure in a dashboard and embed on your website with one script tag. It chats and speaks with your visitors, answers from documents you upload, can act on the page it is embedded in, hands off to a human when it cannot help, and reports on what happened.
This page explains the words used throughout the rest of the documentation. If you would rather get something running first, go to the Quickstart.
What an assistant does
- Chat and voice in the browser. Visitors type or talk to the assistant. Both run through the same instructions, model, and knowledge.
- Answers from your documents. Upload files to the assistant's Knowledge Base and it searches them before answering.
- Acts on your page. With Page Intelligence on, the assistant can read the page it is embedded in, and — if you wire them up — call functions your page exposes. See Page tools.
- Calls your systems. Actions send a signed HTTPS request to an endpoint you own, either on a platform event, when the assistant decides to, or when a visitor submits a form. See Actions.
- Hands off to a human. When the assistant cannot resolve an issue it offers to connect the visitor with your team, using the escalation channels you configure. See Human handoff.
- Reports on outcomes. Every conversation is stored, searchable, and rolled up in Analytics.
Core concepts
Assistant
An assistant is one configured bot. It owns its own:
- Instructions — the plain-English brief that tells it who it is and how to behave.
- Model and response settings — these affect both chat and voice.
- Appearance — colors, presentation, and the copy visitors see.
- Voice — which voice it speaks in and how voice conversations behave.
- Knowledge — the documents it can search.
- Deployment — the site it is embedded on and how requests from that site are authorized.
You configure all of this in the assistant editor, which is split into tabs: General, Appearance, Voice, Channels, Intelligence, and Deploy. Each has its own page in Using Hiroi; the Channels tab is covered in Human handoff.
Assistants are independent. Two assistants on the same account share nothing — separate instructions, separate knowledge, separate conversations.
Conversation
A conversation is one visitor's exchange with an assistant, across chat or voice. Conversations are listed in Conversations, where you can read the full transcript.
If you set a Goal on the assistant — a plain-English description of what success looks like — every ended conversation is graded against it, and that grading feeds the resolution figures in Analytics. Without a goal, that grading does not run.
Credits
Credits are the usage currency. They are not a subscription: you buy a balance, and work draws it down. What consumes credits:
| Activity | Consumes credits for |
|---|---|
| Chat and voice messages | The model call, per thousand tokens |
| Visitor speech | Transcription, per request |
| Spoken replies | Text-to-speech, per thousand characters |
Current rates and your balance are on the Billing and credits page. Your remaining balance is also shown in the dashboard header.
Organization
An organization is the workspace that owns your assistants, conversations, and contacts. Every account gets a personal organization automatically, so you never have to create one to start.
Creating additional organizations and inviting teammates into them is a paid feature. When you belong to more than one, a switcher in the dashboard sidebar (under the Hiroi Assistant wordmark) changes which one you are working in.
Free and paid
Access is binary. There are no subscription tiers.
Paid means the account has ever purchased credits. It is permanent — spending your balance back down to zero does not take the features away.
| Free | Paid | |
|---|---|---|
| Assistants | 1 | 20 |
| Knowledge base documents (per assistant) | 3 | 20 |
| Text and voice chat | Yes | Yes |
| Voice provider | Azure only | Your choice |
| Analytics | Basic | Advanced |
Features that require a paid account:
- Session Signed widget authentication
- Hiding the "Powered by" branding
- Page Intelligence
- Organizations and teams
- Conversation export
- Data retention control
- Advanced analytics, including response times
- A custom text-to-speech endpoint
Free accounts can read every page of this documentation, including the paid ones. Paid features are marked at the point of use.
How it gets onto your site
One script tag, with the site ID from the assistant's Deploy tab:
<script async src="https://hiroi.ai/static/va-wave-widget.js"
data-site-id="YOUR_SITE_ID"></script>
There are two presentations: Widget, a floating orb in a corner of the page, and Minimal, an ambient on-page pill. Both are configured in the editor — you do not change the snippet to switch between them.
By default the assistant only answers requests coming from the domains you list on the assistant, so no secret goes into the browser. See Widget authentication for the alternative, which signs sessions from your own backend.
Where to go next
- Quickstart — create an assistant and get it answering on your site.
- Your account and workspace — signing in, organizations, and account settings.
- Dashboard — what each part of the dashboard shows.
- Developer overview — embedding, authentication, the JavaScript API, page tools, theming, and Actions.
- FAQs — short answers to common questions.