> ## 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. # Public Help Hub > Unauthenticated endpoints for loading a Genie's public Help Hub and reading individual published guides. These routes use `resource: "help-hub"` and require **no API key**. They are intended for consumer-facing surfaces — the public Help Hub page (`/help/:url_name`) and individual guide pages (`/help/:url_name/:documentId`). Only Genies with `is_public: true` (or `is_marketplace_genie: true`) are served. A Help Hub can additionally be disabled per-Genie without making the Genie itself private. Only documents the owner has explicitly marked `is_public` are included in any response from these endpoints. *** ## Get Help Hub Returns the full public data for a Genie's Help Hub: branding, contact details, published guides grouped by topic, featured questions, downloadable resources, and quick-links. `help-hub` `public-get` The Genie's URL slug (e.g. `"acme-support"`). Also accepted as a query parameter. Genie UUID. Genie URL slug. Genie display name. Genie description. Welcome message shown at the top of the hub. Hub branding derived from the Genie's configuration. Primary hex color (e.g. `"#4E9CFF"`). Defaults to `"#4E9CFF"` when unset. Secondary hex color, or `null` when unset. HTTPS URL of the logo image, or `null`. Brand name to display alongside the logo. Live phone number for the Genie, or `null` if no active number is provisioned. Provisioned support email address, or `null` if a mailbox is not active. Quick-links curated by the owner. Maximum 12 links. Link identifier. Link display label. Link destination URL (HTTPS or HTTP). Published guides grouped by folder topic, sorted by folder position then name. Empty when the owner has disabled the guide section. Unfoldered guides appear in a final topic named `"Everything else"`. Topic (folder) ID, or `"unsorted"` for unfoldered guides. Topic display name. Guides in this topic, sorted alphabetically by name. Document UUID. Guide title. One-line description from the document metadata. ISO 8601 last-updated timestamp. Up to 8 questions this guide answers, used for hub search and the guide card preview. Total number of published guides. `0` when the guide section is disabled. Optional custom headline for the hub page. Optional subheadline. Custom placeholder text for the chat input. Featured questions shown on the hub. Curated by the owner when configured; otherwise derived from the questions declared by published guides. Maximum 24. Empty when the owner has disabled the FAQ section. Question identifier. Question text. Topic label the question belongs to. UUID of the guide that answers this question, or `null` if not linked to a specific guide. Downloadable resources (manuals, PDFs). Maximum 24. Resource identifier. Display label. HTTPS URL of the file. Original filename. MIME type (e.g. `"application/pdf"`). File size in bytes. Contact details configured by the owner. `null` when no contact information is set. Business hours text. Physical address. URL to a map or directions page. Whether this hub has opted into search-engine indexing. `true` only when the owner enabled indexing **and** the hub has at least 3 published guides. Whether the "Get the app" band should be shown on the hub page. Defaults to `true`; the owner can disable it without affecting the rest of the hub. ```typescript Request theme={null} const response = await ApiService.invoke({ resource: "help-hub", action: "public-get", data: { url_name: "acme-support" }, }); ``` ```bash cURL theme={null} curl -X POST https://api.helpgenie.ai/v1 \ -H "Content-Type: application/json" \ -d '{ "resource": "help-hub", "action": "public-get", "data": { "url_name": "acme-support" } }' ``` ```json Response theme={null} { "success": true, "data": { "hub": { "genieId": "550e8400-e29b-41d4-a716-446655440000", "urlName": "acme-support", "name": "Acme Support", "description": "Get answers fast.", "branding": { "primaryColor": "#4E9CFF", "secondaryColor": null, "logoUrl": "https://example.com/logo.png", "brandName": "Acme Corp" }, "phoneNumber": "+15551234567", "emailAddress": "support@acme.helpgenie.ai", "topics": [ { "id": "folder-uuid", "name": "Getting Started", "guides": [ { "id": "doc-uuid", "name": "How to create your first account", "summary": "A step-by-step guide for new users.", "updatedAt": "2024-06-26T10:00:00.000Z", "answers": ["How do I sign up?", "What do I need to get started?"] } ] } ], "guideCount": 1, "questions": [ { "id": "doc-uuid:How do I sign up?", "question": "How do I sign up?", "topic": "Getting Started", "documentId": "doc-uuid" } ], "downloads": [], "links": [], "contact": null, "searchEngineVisible": false, "showApp": true } } } ``` *** ## Get guide Returns the full content of a single published guide attached to a Genie's Help Hub. Both the Genie and the document must be public. `help-hub` `public-guide` The Genie's URL slug. UUID of the guide document to retrieve. Document UUID. Guide title. One-line description. The folder this guide belongs to, or `null` if unfoldered. Folder UUID. Folder display name. Full guide text as plain prose. Sections are separated by blank lines. Truncated to 60,000 characters. `true` when the content exceeded 60,000 characters and was trimmed. ISO 8601 last-updated timestamp. Display name of the Genie this guide belongs to. Structured branded document. Present only for guides authored with a branded template (FAQ, how-to, or one-pager). `null` for all other guide types. Document title. Optional subtitle. Template type: `"faq"`, `"how-to"`, or `"one-pager"`. Document sections, in order. Maximum 40 sections. Section heading. Section body text. Line breaks are preserved. Maximum 8,000 characters per section. ```typescript Request theme={null} const response = await ApiService.invoke({ resource: "help-hub", action: "public-guide", data: { url_name: "acme-support", document_id: "770e8400-e29b-41d4-a716-446655440002", }, }); ``` ```bash cURL theme={null} curl -X POST https://api.helpgenie.ai/v1 \ -H "Content-Type: application/json" \ -d '{ "resource": "help-hub", "action": "public-guide", "data": { "url_name": "acme-support", "document_id": "770e8400-e29b-41d4-a716-446655440002" } }' ``` ```json Response theme={null} { "success": true, "data": { "guide": { "id": "770e8400-e29b-41d4-a716-446655440002", "name": "How to create your first account", "summary": "A step-by-step guide for new users.", "topic": { "id": "folder-uuid", "name": "Getting Started" }, "content": "Visit our website and click Sign up.\n\nEnter your business details and follow the setup wizard.\n\nYou will receive a confirmation email within a few minutes.", "truncated": false, "updatedAt": "2024-06-26T10:00:00.000Z", "genieName": "Acme Support", "genieDocument": null } } } ``` *** ## Error responses | Status | Code | Description | | ------ | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | 400 | `VALIDATION_ERROR` | `url_name` or `document_id` missing from the request | | 404 | `NOT_FOUND` | Genie not found or not public; hub disabled by the owner; document not found, not public, or not attached to this Genie; guide content still being prepared | | 500 | `INTERNAL_ERROR` | Server error |