Skip to main content

Base URLs

HelpGenie supports both REST-style routes and direct Supabase function invocation.
REST routes follow:

Authentication

All auth methods use the Authorization header.
  • Prefix: hg_live_
  • Rate limit: 60 requests/minute per key
  • Maximum 5 active keys per user

Session JWT (browser/app context)

Service role key (server-to-server)

Request formats

Custom actions (POST body)

Direct invocation (POST body)

string
required
API resource name. Example: genies, knowledge-base, integrations, api-keys.
string
required
Action for the selected resource (for example list, get, create, update, delete).
string
Optional resource identifier for single-record actions.
object
Action-specific parameters (filters, pagination, payload fields).

Response envelope

Error (4xx / 5xx):

Error codes

Access control

Roles determine access scope:
  • internal_admin - Full cross-account access.
  • standard_user - Access to their own business data.
  • consumer - Limited read-only/interaction access.
Admin users can pass adminMode: true or a userId parameter to operate on resources owned by other users.

Resource map

Genies

Create, update, list, and delete voice AI genies

Genie groups

Group and organize genies

Conversations

Sync, analyze, and manage conversations

Knowledge base

Manage documents and attach them to genies

Document folders

Organize knowledge base documents into folders

Voices

Manage voice favorites and track usage

Voice collections

Create and manage curated voice collections

Leads

Capture and manage customer leads

Lead notes

Add and manage notes on leads

Marketplace

Browse and publish genie templates

Profiles

Manage user profiles and settings

Teams

Create teams, invite members, manage roles

Activities

Track platform activity and audit logs

Goals

Manage agent goals and outcomes

API keys

Create, revoke, and delete developer API keys

Phone numbers

Provision, release, and manage Twilio phone numbers

QR codes

Manage QR code images for genie pages

Worker genies

Autonomous background AI agents for tasks and integrations

Analytics

Platform analytics, trends, and genie performance

Billing

Subscriptions, usage, invoices, and checkout

Branding

Team branding, logos, and style configuration

Portals

Create multi-genie portal pages

Agent pages

Manage individual genie landing pages

Integrations

Connect external services and APIs

Automations

Create and manage automated workflows

Playbooks

Browse and apply pre-built genie playbooks

Capabilities

Discover resources and actions at runtime