# Help Genie

> API documentation for the Help Genie voice AI platform

## Docs

- [Activation Packs](https://docs.helpgenie.ai/api-reference/activation-packs.md): Create and manage launch packs that bundle a genie or portal with promotional copy, branding, and distribution channels
- [Activities](https://docs.helpgenie.ai/api-reference/activities.md): Query and create audit log entries that track user and system actions
- [Agent Pages](https://docs.helpgenie.ai/api-reference/agent-pages.md): Standalone landing pages for Genies.
- [Analytics](https://docs.helpgenie.ai/api-reference/analytics.md): Account analytics, trends, genie performance, and period comparisons
- [API keys](https://docs.helpgenie.ai/api-reference/api-keys.md): Create, list, revoke, and delete developer API keys for programmatic access
- [Billing](https://docs.helpgenie.ai/api-reference/billing.md): Subscription, usage, and Stripe delegated billing actions
- [Brand Integrity](https://docs.helpgenie.ai/api-reference/brand-integrity.md): Run and manage Brand Integrity audits — automated tests that verify your Genie behaves on-brand across a suite of conversation scenarios.
- [Branding](https://docs.helpgenie.ai/api-reference/branding.md): Manage team-level branding (logo, colors, QR code, embed styles) and generate AI logos.
- [Capabilities](https://docs.helpgenie.ai/api-reference/capabilities.md): Runtime discovery of resources and supported actions
- [Context Sources](https://docs.helpgenie.ai/api-reference/context-sources.md): Manage live data integrations that supply real-time context to your Genies during conversations.
- [Conversations](https://docs.helpgenie.ai/api-reference/conversations.md): List, retrieve, sync, analyze, update, and delete conversation records
- [Demo Genies](https://docs.helpgenie.ai/api-reference/demo-genies.md): Demo genie provisioning and lifecycle
- [Document Edit Links](https://docs.helpgenie.ai/api-reference/doc-edit-link.md): Share a document for external editing — no login required. Generate tokenised edit links, optionally secure them with a PIN, and let anyone with the link view or update the document's content.
- [Document folders](https://docs.helpgenie.ai/api-reference/document-folders.md): Organize knowledge base documents into folders
- [Email Logs](https://docs.helpgenie.ai/api-reference/email-logs.md): Delivery log retrieval for outbound emails
- [Email Templates](https://docs.helpgenie.ai/api-reference/email-templates.md): Template CRUD for conversation and customer email workflows
- [Escalation Webhooks](https://docs.helpgenie.ai/api-reference/escalation-webhooks.md): Configure webhooks that fire when a Genie escalates a conversation to a human agent.
- [Genie Access](https://docs.helpgenie.ai/api-reference/genie-access.md): Manage access control for private Genies — create shareable access links, grant direct user access, and handle inbound access requests.
- [Genie Documents](https://docs.helpgenie.ai/api-reference/genie-documents.md): Generate polished, ready-to-share documents from your Genie's knowledge base — FAQs, how-to guides, and one-pagers, all grounded in your own content.
- [Genie groups](https://docs.helpgenie.ai/api-reference/genie-groups.md): Organize genies into groups for easier management
- [Genies](https://docs.helpgenie.ai/api-reference/genies.md): Create, configure, list, and manage voice AI genies
- [Goals](https://docs.helpgenie.ai/api-reference/goals.md): Manage goal records, outcomes, and lead-info presets for agents
- [Insights](https://docs.helpgenie.ai/api-reference/insights.md): Derived outcome signals and the 'needs attention' feed — powering the Activity page summary tiles and prioritised action list.
- [API reference](https://docs.helpgenie.ai/api-reference/introduction.md): Complete API conventions: auth, request formats, errors, and core resources
- [Knowledge base](https://docs.helpgenie.ai/api-reference/knowledge-base.md): Manage documents, attach them to genies, and sync content across agents
- [Lead notes](https://docs.helpgenie.ai/api-reference/lead-notes.md): Manage notes attached to leads with pinning support and full CRUD operations.
- [Leads](https://docs.helpgenie.ai/api-reference/leads.md): Manage and query lead records associated with your agents, including filtering, statistics, and admin operations.
- [Learn](https://docs.helpgenie.ai/api-reference/learn.md): Access Learn Hub articles and track per-user reading progress for in-product education.
- [Marketplace](https://docs.helpgenie.ai/api-reference/marketplace.md): Browse, search, and manage marketplace genie listings with categories and statistics.
- [Phone numbers](https://docs.helpgenie.ai/api-reference/phone-numbers.md): Provision, release, and manage Twilio phone numbers for voice agents
- [Playbooks](https://docs.helpgenie.ai/api-reference/playbooks.md): Playbook listing and apply workflow
- [Portals](https://docs.helpgenie.ai/api-reference/portals.md): Portal CRUD, genie assignment, and distribution actions
- [Profiles](https://docs.helpgenie.ai/api-reference/profiles.md): Manage user profiles including account information, subscription details, and team associations.
- [Pronunciation Vaults](https://docs.helpgenie.ai/api-reference/pronunciation-vaults.md): Shared pronunciation dictionaries that define how your Genies pronounce specific words and names.
- [Public Agent Pages](https://docs.helpgenie.ai/api-reference/public-agent-pages.md): Unauthenticated endpoints for loading and requesting access to Agent Pages.
- [Public Genies](https://docs.helpgenie.ai/api-reference/public-genies.md): Unauthenticated endpoints for loading, browsing, and interacting with public Genies.
- [QR codes](https://docs.helpgenie.ai/api-reference/qr-code.md): Manage saved QR code images for genie conversation pages
- [Teams](https://docs.helpgenie.ai/api-reference/teams.md): Manage teams, team membership, and invitations.
- [Voice collections](https://docs.helpgenie.ai/api-reference/voice-collections.md): DEPRECATED — the voice-collections resource has been removed
- [Voices](https://docs.helpgenie.ai/api-reference/voices.md): Browse and search voices, manage favorites, and track voice usage
- [Worker genies](https://docs.helpgenie.ai/api-reference/worker-genies.md): Create and manage autonomous background AI agents that execute tasks on schedule, by event, or manually
- [Authentication](https://docs.helpgenie.ai/getting-started/authentication.md): Authenticate with the HelpGenie API using API keys or session tokens
- [Error handling](https://docs.helpgenie.ai/getting-started/errors.md): Understand error response formats and handle API errors in your application
- [Introduction](https://docs.helpgenie.ai/getting-started/introduction.md): Learn about the HelpGenie API architecture and available resources
- [Making requests](https://docs.helpgenie.ai/getting-started/making-requests.md): Learn how to structure API requests, understand response formats, and use common patterns
- [Developer Standards MCP](https://docs.helpgenie.ai/getting-started/mcp-server.md): Add the Help Genie MCP server to your AI coding tools to share team coding rules, patterns, and standards automatically.
- [HelpGenie API](https://docs.helpgenie.ai/index.md): Build with the HelpGenie voice AI platform API
- [Calendar](https://docs.helpgenie.ai/mail-guide/calendar.md): See your meetings alongside your mail
- [Compose, Reply & Attachments](https://docs.helpgenie.ai/mail-guide/compose-and-send.md): Write new email, reply, and attach files
- [Connecting Your Email Account](https://docs.helpgenie.ai/mail-guide/connecting-accounts.md): Link Gmail or Outlook to get started
- [The Genie Feed](https://docs.helpgenie.ai/mail-guide/genie-feed.md): Let AI triage your inbox and approve what it gets right
- [Inbox, Threads & Search](https://docs.helpgenie.ai/mail-guide/inbox-and-search.md): Browse, organize, and search your mail directly
- [Help Genie Mail](https://docs.helpgenie.ai/mail-guide/introduction.md): Bring Gmail and Outlook together in one place, with AI handling triage, replies, and follow-ups in the background.
- [Getting Started](https://docs.helpgenie.ai/mail-guide/onboarding.md): Your first-run walkthrough
- [Settings](https://docs.helpgenie.ai/mail-guide/settings.md): Configure accounts, notifications, and behavior
- [Campaigns](https://docs.helpgenie.ai/outbound-guide/campaigns.md): Create, launch, and monitor outbound calling campaigns
- [Getting Started with Outbound](https://docs.helpgenie.ai/outbound-guide/getting-started.md): Set up your first outbound calling campaign
- [Help Genie Outbound](https://docs.helpgenie.ai/outbound-guide/introduction.md): Let your Genie place real phone calls and run calling campaigns end to end.
- [Activity & Replay](https://docs.helpgenie.ai/sync-guide/activity-and-replay.md): See everything your genie has done, and retry anything that failed.
- [Capabilities](https://docs.helpgenie.ai/sync-guide/capabilities.md): Give your genie the ability to look things up and take action, live, during a call.
- [Connections](https://docs.helpgenie.ai/sync-guide/connections.md): Link Sync to the tools and systems your business already uses.
- [FAQ & Troubleshooting](https://docs.helpgenie.ai/sync-guide/faq-troubleshooting.md): Answers to common questions and fixes for common issues.
- [Getting Started](https://docs.helpgenie.ai/sync-guide/getting-started.md): Complete the setup wizard to get your first genie running in Sync.
- [What is Help Genie Sync?](https://docs.helpgenie.ai/sync-guide/introduction.md): The lifecycle model behind every genie — before, during, and after the call.
- [Knowledge Sync](https://docs.helpgenie.ai/sync-guide/knowledge-sync.md): Keep your genie's knowledge current, automatically.
- [Post-Call Actions](https://docs.helpgenie.ai/sync-guide/post-call-actions.md): Automatically follow up the moment a call ends.
- [Account Branding](https://docs.helpgenie.ai/voice-guide/account-branding.md): Set the default logo, colors, and styling applied to every new Genie you create.
- [Account Settings](https://docs.helpgenie.ai/voice-guide/account-settings.md): Manage your profile, team, security, billing, phone numbers, API keys, and troubleshooting tools from one place.
- [Activation](https://docs.helpgenie.ai/voice-guide/activation.md): Turn any Genie into ready-to-ship activation assets — a branded microsite, one smart link, QR codes, print packs, email signatures, and launch copy.
- [Creating an activation pack](https://docs.helpgenie.ai/voice-guide/activation-create.md): How activation packs are created — automatically for each Genie, or built by hand for a Genie or portal with the channels and materials you choose.
- [Genie Trust Center](https://docs.helpgenie.ai/voice-guide/brand-integrity.md): Stress-test a Genie's behaviour across the conversations it might face — run full audits, targeted evaluations, and manual tests, then review the results and export a report.
- [Email Templates](https://docs.helpgenie.ai/voice-guide/email-templates.md): Customize the colors, fonts, sections and branding of the report emails your Genies send, and preview them live before saving.
- [Genie Access](https://docs.helpgenie.ai/voice-guide/genie-access.md): Manage who can use each of your private Genies — approve or deny access requests, review current users, set access expiry, and see who's scanned your QR codes.
- [Listener Genies & Reviewing Your Genie](https://docs.helpgenie.ai/voice-guide/genie-setup-listener-form.md): Set up a meeting-recording Listener Genie, then review and fine-tune any Genie before creating it.
- [Setting Up a Genie](https://docs.helpgenie.ai/voice-guide/genie-setup-overview.md): How the guided setup flow works — pick a starting point, describe your Genie, review the details, and create it.
- [Setting Up a Genie by Voice](https://docs.helpgenie.ai/voice-guide/genie-setup-voice-flow.md): Talk your Genie into existence — how the voice setup step works, plus screen-awake and iPhone tap behavior.
- [Genie Templates](https://docs.helpgenie.ai/voice-guide/genie-templates.md): Browse a catalogue of ready-made Genies by business function and deploy one pre-configured in a couple of minutes.
- [Inbox](https://docs.helpgenie.ai/voice-guide/inbox.md): See every conversation your Genies have had, and turn those conversations into spreadsheet-style Views you can shape however you want.
- [Insights](https://docs.helpgenie.ai/voice-guide/insights-hub.md): Understand what's working across your Genies — a plain-English story of your conversations, performance analytics, and an audit trail of every change, all in one place.
- [Knowledge Base](https://docs.helpgenie.ai/voice-guide/knowledge-base.md): Upload, organize, and manage the documents your Genies draw on to answer callers.
- [A Genie's Knowledge](https://docs.helpgenie.ai/voice-guide/knowledge-base-genie.md): View, coach, and manage the documents attached to a single Genie.
- [Genie Appearance & Advanced Settings](https://docs.helpgenie.ai/voice-guide/my-genies-advanced-settings.md): Fine-tune how your Genie looks and behaves — branding, page resources, closing page, response intelligence, conversation flow, tools, events, and private data sources.
- [Genie Usage & Billing](https://docs.helpgenie.ai/voice-guide/my-genies-billing.md): See a Genie's call limits and top up capacity — the usage and billing controls on a Genie's configuration screen.
- [Genie Identity, Voice & Prompts](https://docs.helpgenie.ai/voice-guide/my-genies-identity-voice.md): Configure who your Genie is and how it speaks — name and profile, voice and speech, system prompt, welcome messages, and pronunciations.
- [Genie Knowledge & Distribution](https://docs.helpgenie.ai/voice-guide/my-genies-knowledge-distribution.md): Give your Genie knowledge, decide what it collects, and get it in front of people — insights, knowledge base, branded documents, and distribution channels.
- [My Genies](https://docs.helpgenie.ai/voice-guide/my-genies-list.md): Browse, search, group, and organize all of your Genies from one place — the home base for everything you've built.
- [Portals](https://docs.helpgenie.ai/voice-guide/portals.md): Create custom pages that showcase multiple genies together — group your genies, brand the page, and share it with a single link.
- [Suite Apps](https://docs.helpgenie.ai/voice-guide/suite-apps.md): Meet the Help Genie Suite apps — Mail, Outbound and Sync. Each is a companion app you reach from its splash page inside Genie Hub.
- [Unfinished Setups](https://docs.helpgenie.ai/voice-guide/unfinished-setups.md): Pick up a Genie setup you started earlier but didn't finish — resume where you left off, review what you'd already covered, or remove setups you no longer want.
- [Voice Playground](https://docs.helpgenie.ai/voice-guide/voice-playground.md): Browse, filter, preview and test the voices available for your Help Genie — then create your own custom voice to match your brand.

## OpenAPI Specs

- [openapi](https://docs.helpgenie.ai/api-reference/openapi.json)

## Optional

- [App](https://helpgenie.ai)