Capabilities

Use capabilities to discover the API at runtime: the full resource and action map, the schema of one resource or action, a primer for agents and integrations, the genie capability reference, and the platform how-to guides.

Action	Description	Auth
`get` / `list`	Full map of every resource and its actions	Public
`schema`	Schema of one resource, or of one action	Public
`guide`	Primer for agents and integrations, as markdown	API key or session
`genie-capability`	Reference for creating, configuring, sharing and managing a genie	API key or session
`platform-guide`	Plain-language how-to guides for platform features	API key or session

Any action value not listed above returns the full map, the same as get. Calling guide, genie-capability or platform-guide without an API key or session returns UNAUTHORIZED.

Actions

`get` / `list`

Returns every resource with its description and actions. The response is large. To look up one resource or action, use schema instead.

string

required

Must be "capabilities"

string

"get" or "list". Any value not listed in the table above also returns this map.

object

Show properties

object

Map of resource name to its schema.

Show properties

string

What the resource is for.

boolean

Present and true only for deprecated resources.

object

Map of action name to its schema (description, requiresId, requiresData, dataSchema, notes, responseExample, destructive, requiresConfirmation).

const { capabilities } = await ApiService.invoke({
  resource: "capabilities",
  action: "list",
});

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource": "capabilities", "action": "list"}'

Response

{
  "success": true,
  "data": {
    "capabilities": {
      "knowledge-base": {
        "description": "Upload and manage documents for genies to learn from.",
        "actions": {
          "create": {
            "description": "Create and upload a new document.",
            "requiresData": true,
            "dataSchema": {
              "content": "string (required for the default notes upload — the document text)"
            }
          }
        }
      }
    }
  }
}

`schema`

Returns the schema of one resource (every action) or of one action. Names are matched without regard to case or separators, so toggle_pin, toggle-pin and TogglePin all find togglePin, and knowledgeBase finds knowledge-base. The response gives the exact resource and action names. Every other call needs those exact names. If a name is unknown, or matches more than one resource or action, the call fails with VALIDATION_ERROR and the error message lists the valid names.

string

required

Resource name, e.g. "genies".

string

Action name, e.g. "update". Omit it to get every action of the resource.

object

Show properties

string

The exact resource name.

string

The exact action name. Present only when action was passed.

object

The action’s schema: description, requiresId, requiresData, dataSchema, notes, responseExample, destructive, requiresConfirmation. Present only when action was passed.

string

The resource description. Present only when action was omitted.

object

Map of action name to its schema. Present only when action was omitted.

const { resource, action, schema } = await ApiService.invoke({
  resource: "capabilities",
  action: "schema",
  data: { resource: "lead_notes", action: "toggle-pin" },
});
// resource === "lead-notes", action === "togglePin"

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "capabilities",
    "action": "schema",
    "data": { "resource": "genies", "action": "update" }
  }'

Response

{
  "success": true,
  "data": {
    "resource": "genies",
    "action": "update",
    "schema": {
      "description": "Update genie. Flat fields update directly; nested settings.* deep-merge. Mix both in one call.",
      "requiresId": true,
      "requiresData": true,
      "dataSchema": { "name": "string (optional)" }
    }
  }
}

`guide`

Returns the primer for agents and integrations, as markdown. It covers the request envelope, which account a call runs as, how to look things up before calling, how to write safely, and an index of resources, genie capabilities and platform guide topics. Read it first. Requires an API key or session.

string

The primer, as markdown.

const { guide } = await ApiService.invoke({
  resource: "capabilities",
  action: "guide",
});

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource": "capabilities", "action": "guide"}'

Response

{
  "success": true,
  "data": {
    "guide": "# Help Genie API…"
  }
}

`genie-capability`

Returns the checked reference for creating, configuring, sharing or managing a genie. With no id, it returns the index: every capability, grouped by area. With id or ids, it returns each capability’s behaviour, limits, and the exact API calls and fields that change it. Requires an API key or session.

string

Capability id from the index, e.g. "system-prompt". You can also pass it as the request id.

string[]

Several capability ids in one call.

Ids are matched without regard to case. Ids that don’t match a capability are returned in unknown_ids. If none match, the call fails with VALIDATION_ERROR and the error message lists the valid ids.

object

Show properties (index — no id)

object[]

Show properties

string

Area key, e.g. "prompts".

string

Area title, e.g. "Prompt, greetings and link".

object[]

Each capability’s id, title and summary.

Show properties (with id or ids)

object[]

Show properties

string

Capability id.

string

Capability title.

string

Area key.

string

One-line summary.

string[]

How owners usually ask for this.

string[]

What it does, its rules, limits and defaults, and what customers see.

object[]

The calls that change it: resource, action, fields (top-level data keys) and usage (how to build the call, including nested paths and merge behaviour). Empty when it can only be changed in the app.

string

What can’t be done through the API. When api is empty, this is "Not available through the API. It is done in the app."

string[]

Requested ids that matched no capability. Present only when some ids didn’t match.

const { capabilities, unknown_ids } = await ApiService.invoke({
  resource: "capabilities",
  action: "genie-capability",
  data: { ids: ["system-prompt", "genie-branding"] },
});

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "capabilities",
    "action": "genie-capability",
    "data": { "id": "system-prompt" }
  }'

Response

{
  "success": true,
  "data": {
    "capabilities": [
      {
        "id": "system-prompt",
        "title": "System prompt",
        "area": "prompts",
        "summary": "The genie's core instructions: personality, what it knows, how it behaves.",
        "askedAs": ["Make my genie more friendly", "Tell it not to discuss pricing"],
        "behaviour": ["Changes apply to new conversations after saving."],
        "api": [
          {
            "resource": "genies",
            "action": "update",
            "fields": ["settings"],
            "usage": "Only settings.conversation_config.agent.prompt.prompt sets it; a flat 'prompt' is rejected."
          }
        ]
      }
    ]
  }
}

`platform-guide`

Returns a plain-language how-to guide for a platform feature. With no topic, it returns the topic index. With topic, it returns that guide as markdown. The guides are written for business owners, so they describe the app as well as the feature. Requires an API key or session.

string

Topic slug from the index, e.g. "knowledge-base". Matched without regard to case. An unknown topic fails with VALIDATION_ERROR and the error message lists the valid topics.

object

Show properties

object[]

The topic index: each topic’s topic slug and description. Present only when topic was omitted.

string

The requested topic. Present only when topic was passed.

string

The guide, as markdown. Present only when topic was passed.

const { topic, content } = await ApiService.invoke({
  resource: "capabilities",
  action: "platform-guide",
  data: { topic: "knowledge-base" },
});

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource": "capabilities", "action": "platform-guide"}'

Response

{
  "success": true,
  "data": {
    "topics": [
      { "topic": "getting-started", "description": "First-time setup, account overview, onboarding steps" },
      { "topic": "knowledge-base", "description": "Uploading documents, creating text knowledge, training your genie" }
    ]
  }
}

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Actions

`get` / `list`

`schema`

`guide`

`genie-capability`

`platform-guide`

​Actions

​get / list

​schema

​guide

​genie-capability

​platform-guide

Actions

`get` / `list`

`schema`

`guide`

`genie-capability`

`platform-guide`