# Help Genie

> API documentation for the Help Genie voice AI platform

## Docs

- [Activation Packs](https://docs.helpgenie.ai/api-reference/activation-packs.md): Activation pack CRUD and generation workflows
- [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 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 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): Create, manage, and organize collections of voices for easy access and reuse
- [Voices](https://docs.helpgenie.ai/api-reference/voices.md): Manage favorite voices, browse popular and recent voices, 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
- [HelpGenie API](https://docs.helpgenie.ai/index.md): Build with the HelpGenie voice AI platform API

## OpenAPI Specs

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

## Optional

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