Help Hub

The Help Hub is a customer-facing support page built automatically from a genie’s public knowledge base. Both actions are public — no authentication required.

Get Support Hub

Returns the full Support Hub data for a genie by URL slug: branding, topics, published guides, featured questions, contact info, links, and downloads.

Returns 404 if the genie is private, inactive, or has disabled its hub.

string

required

Must be "help-hub"

string

required

Must be "public-get"

object

required

Show properties

string

required

The genie’s URL slug.

boolean

object

Show properties

object

Brand colours and logo.

object

Genie metadata (name, description, welcome message).

object[]

Help topic categories.

object[]

Published knowledge base guides.

string[]

Pre-loaded questions shown to visitors.

object | null

Contact details if configured.

object[]

Informational links on the hub.

object[]

Downloadable files on the hub.

const response = await fetch("https://api.helpgenie.ai/v1", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    resource: "help-hub",
    action: "public-get",
    data: { url_name: "acme-support" },
  }),
});

curl -X POST https://api.helpgenie.ai/v1/help-hub \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "help-hub",
    "action": "public-get",
    "data": {
      "url_name": "acme-support"
    }
  }'

Get published guide

Fetches the full content of one published guide (knowledge base document) from a Support Hub.

string

required

Must be "help-hub"

string

required

Must be "public-guide"

object

required

Show properties

string

required

The hub’s URL slug.

string

required

Knowledge base document ID. May also be passed as the request id.

boolean

object

Show properties

object

Full document content including name, body, and metadata.

const response = await fetch("https://api.helpgenie.ai/v1", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    resource: "help-hub",
    action: "public-guide",
    data: {
      url_name: "acme-support",
      document_id: "doc-uuid",
    },
  }),
});

curl -X POST https://api.helpgenie.ai/v1/help-hub \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "help-hub",
    "action": "public-guide",
    "data": {
      "url_name": "acme-support",
      "document_id": "doc-uuid"
    }
  }'

Error codes

Code	Meaning
`NOT_FOUND`	Genie hub not found, private, or inactive
`INTERNAL_ERROR`	Unexpected server error

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Get Support Hub

Get published guide

Error codes

​Get Support Hub

​Get published guide

​Error codes

Get Support Hub

Get published guide

Error codes