For Developers
Ship every integration, workflow, and webhook.
One API creates, configures, and deploys branded voice and chat genies straight from your code. Thirteen resources, REST or single-endpoint, Bearer-token auth.
// One API. 13 resources. Shipped from your stack.
# List every genie in your account
curl https://api.helpgenie.ai/v1/genies \
-H "Authorization: Bearer $HELPGENIE_TOKEN"const res = await fetch("https://api.helpgenie.ai/v1/genies", {
headers: { Authorization: `Bearer ${token}` },
});
const { data } = await res.json();{
"data": [
{
"id": "gen_a1b2c3d4",
"name": "Front Desk Genie",
"url_name": "front-desk",
"voice": "aria",
"is_active": true
}
],
"count": 1
}13
REST resources, one base URL
2 ways
REST paths or single-endpoint
Bearer
Supabase Auth, no OAuth dance
1 iframe
to embed voice anywhere
Live in three calls
No conversation infrastructure to build. Authenticate, create a genie, and put it in front of customers.
- 01
Authenticate
Sign a request with a Bearer token from Supabase Auth. No SDK to install, no OAuth dance.
- 02
Create a genie
One POST provisions a branded voice or chat genie — name, voice, knowledge base, and lead goals.
- 03
Go live
Drop the returned genie into any page with one iframe, or wire it to a phone number and QR code.
# 1 · Bearer token from Supabase Auth
export HELPGENIE_TOKEN="eyJhbGciOi..."
# 2 · Create a branded genie
curl -X POST https://api.helpgenie.ai/v1/genies \
-H "Authorization: Bearer $HELPGENIE_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "Front Desk", "voice": "aria" }'
# 3 · Go live — drop it into any page
<iframe src="https://helpgenie.ai/embed/front-desk"
allow="microphone"></iframe>
API reference
One API. Thirteen resources.
Every part of the platform is addressable — genies, knowledge, voice, CRM, and your team. Typed, predictable, and grouped the way you'd expect.
Agent Management
Genies
Genie Groups
Conversations
Knowledge
Knowledge Base
Document Folders
Voice
Voices
Voice Collections
CRM
Leads
Lead Notes
Marketplace
Marketplace
Platform
Profiles
Teams
Activities
Two ways to call it
Use resource-based REST paths, or invoke any resource and action from a single endpoint. Same auth, same responses.
REST paths
Resource-basedGET /v1/genies
POST /v1/genies
PATCH /v1/genies/{id}
DELETE /v1/genies/{id}Direct invocation
One endpointPOST /v1
{
"resource": "genies",
"action": "list",
"id": null,
"data": {}
}Your logic. Our conversation engine.
Everything you need to add branded voice and chat to your product, without building the hard parts yourself.
Full genie lifecycle
Create, configure, deploy, and retire genies programmatically — voice, knowledge base, branding, and lead goals, all scriptable.
Knowledge base, in sync
Push docs, FAQs, and website content into a genie’s knowledge base, then sync it to every agent that uses it.
Conversations & analytics
Pull transcripts, run sentiment and topic analysis on any conversation, and stream the results into your own dashboards.
Leads & CRM
Every qualified conversation becomes a structured lead. Read stats, attach notes, and push records straight to your CRM.
Webhooks & real-time
Subscribe to conversation and lead events. The moment a genie captures a lead, your systems know about it.
Embed anywhere
Ship a voice widget into any site or app with one iframe, or build a fully custom UI on the conversation engine.
What developers build with Help Genie
Voice-enabled product support
Wire a genie into your product so customers get instant, knowledge-base-grounded answers without leaving your app.
Conversational lead capture
Replace static forms with a genie that qualifies prospects in conversation and pushes structured leads to your CRM via webhook.
White-label consumer apps
Build your own branded experience on the conversation engine — your UI, your logic, our voice and chat infrastructure.
Get a key and ship today
Provision your first genie in minutes. Free to start — no conversation infrastructure to build or maintain.