> ## Documentation Index
> Fetch the complete documentation index at: https://docs.helpgenie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# HelpGenie API

> Build with the HelpGenie voice AI platform API

The HelpGenie API gives you programmatic access to voice agents, knowledge bases, conversations, leads, and more. All 13 resources are available through a single endpoint using a consistent request and response format.

## Get started

<Columns cols={2}>
  <Card title="Introduction" icon="book" href="/getting-started/introduction">
    Learn about the API architecture, the resource/action pattern, and available resources.
  </Card>

  <Card title="Authentication" icon="lock" href="/getting-started/authentication">
    Obtain a Bearer token from Supabase Auth and authenticate your requests.
  </Card>

  <Card title="Making requests" icon="code" href="/getting-started/making-requests">
    Understand request structure, response envelopes, and common patterns.
  </Card>

  <Card title="Error handling" icon="triangle-exclamation" href="/getting-started/errors">
    Handle errors with standardized error codes and response formats.
  </Card>
</Columns>

## API reference

<Columns cols={3}>
  <Card title="Agents" icon="robot" href="/api-reference/genies">
    Create and manage voice agents (genies), groups, and conversations.
  </Card>

  <Card title="Knowledge" icon="book-open" href="/api-reference/knowledge-base">
    Manage documents and organize them into folders for your agents.
  </Card>

  <Card title="Voice" icon="microphone" href="/api-reference/voices">
    Browse voices, manage favorites, and organize voice collections.
  </Card>

  <Card title="CRM" icon="address-book" href="/api-reference/leads">
    Track leads captured by your agents and attach notes.
  </Card>

  <Card title="Marketplace" icon="store" href="/api-reference/marketplace">
    Browse and manage marketplace agent templates.
  </Card>

  <Card title="Platform" icon="gear" href="/api-reference/profiles">
    Manage user profiles, teams, and activity logs.
  </Card>
</Columns>

## Quick reference

Every resource and its available actions at a glance:

| Resource          | Actions                                                                                           |
| ----------------- | ------------------------------------------------------------------------------------------------- |
| Genies            | `list` `all` `get` `create` `update` `delete` `reorder`                                           |
| Knowledge Base    | `list` `get` `create` `update` `delete` `sync-with-agents` `attach` `detach` `replace`            |
| Document Folders  | `all` `list` `get` `create` `update` `delete` `reorder` `counts`                                  |
| Genie Groups      | `list` `get` `create` `update` `delete` `reorder` `counts` `sync`                                 |
| Conversations     | `list` `get` `sync` `analyze` `update` `delete`                                                   |
| Voices            | `favorites` `popular` `recent` `add-favorite` `remove-favorite` `track-usage`                     |
| Voice Collections | `all` `get` `create` `update` `delete`                                                            |
| Leads             | `stats` `all` `list` `get` `create` `update` `delete`                                             |
| Lead Notes        | `list` `get` `create` `update` `delete` `togglePin` `pinned`                                      |
| Marketplace       | `list` `all` `get` `create` `update` `delete` `categories` `stats`                                |
| Profiles          | `all` `list` `get` `create` `update` `delete`                                                     |
| Teams             | `get` `create` `update` `delete` `members` `invite` `invitations` `cancel-invite` `remove-member` |
| Activities        | `all` `get` `create`                                                                              |

<Info>
  All requests are `POST` to a single endpoint with the `resource` and `action` specified in the request body. See [Making requests](/getting-started/making-requests) for full details.
</Info>