Genie Documents

Genie Documents lets you produce professionally written documents directly from the knowledge base attached to a Genie. You choose a template, select the source documents to draw from, and receive a structured, print-ready result in seconds. All generated content is grounded strictly in the source material you provide — no facts are invented. The output is structured as an ordered list of sections, each with a heading and body, ready to render or export.

Generate document

Produces a structured document from one or more knowledge-base documents using a Smart template. Only documents you own (or public documents) can be used as sources.

string

required

Must be "genie-documents"

string

required

Must be "generate"

object

required

Show properties

string

required

The Genie UUID. Used to scope the request to a specific assistant.

string

required

The document template to use. One of:

"faq" — Frequently Asked Questions sheet (6–12 Q&A pairs)
"how-to" — Step-by-step guide with an intro and next-steps section
"one-pager" — Concise 4–6 section overview of your business

string[]

required

Array of knowledge-base document UUIDs to use as source material. At least one document is required. Documents are combined up to an internal character limit; the largest documents are trimmed first if the total exceeds the limit.

string

Optional plain-text description of the document’s focus (e.g. "returning customer onboarding"). When omitted, the template covers the most broadly useful information from the source material.

string

Display name of the business or assistant. Used to address the reader in the generated content. Defaults to "your business" if omitted.

boolean

Whether the request succeeded.

object

Show properties

object

The generated document.

Show properties

string

Document title.

string

Optional one-line subtitle or tagline. May be an empty string.

string

The template key that was used ("faq", "how-to", or "one-pager").

array

Ordered content sections.

Show item properties

string

Section heading (or the question text for FAQs).

string

Section content as plain text. Paragraphs are separated by blank lines. Bullet points start with "- " and numbered steps start with "1. ".

object

Generation metadata.

Show properties

string[]

Names of documents that contributed content to the output.

string[]

Names of documents that were skipped (no readable content yet, or access denied).

boolean

Whether any document content was trimmed to fit within the generation limit.

const response = await ApiService.invoke({
  resource: "genie-documents",
  action: "generate",
  data: {
    agentId: "550e8400-e29b-41d4-a716-446655440000",
    template: "faq",
    documentIds: [
      "770e8400-e29b-41d4-a716-446655440002",
      "880e8400-e29b-41d4-a716-446655440003",
    ],
    purpose: "common questions from new customers",
    genieName: "Acme Support",
  },
});

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "genie-documents",
    "action": "generate",
    "data": {
      "agentId": "550e8400-e29b-41d4-a716-446655440000",
      "template": "faq",
      "documentIds": [
        "770e8400-e29b-41d4-a716-446655440002",
        "880e8400-e29b-41d4-a716-446655440003"
      ],
      "purpose": "common questions from new customers",
      "genieName": "Acme Support"
    }
  }'

{
  "success": true,
  "data": {
    "document": {
      "title": "Frequently Asked Questions",
      "subtitle": "Everything a new customer needs to know",
      "template": "faq",
      "sections": [
        {
          "heading": "What are your business hours?",
          "body": "We're open Monday through Friday, 9am to 5pm. Our team typically responds to messages within one business day."
        },
        {
          "heading": "How do I get started?",
          "body": "Simply create an account on our website and follow the setup wizard. The whole process takes under five minutes.\n\n1. Visit our website and click \"Sign up\"\n2. Enter your business details\n3. Connect your first channel"
        }
      ]
    },
    "meta": {
      "sourceDocuments": ["Product Overview", "Support Handbook"],
      "skippedDocuments": [],
      "truncated": false
    }
  }
}

Save document

Persists a generated document as a permanent knowledge-base record linked to the specified Genie. Use this after generate to store the result so it can be managed, published, and surfaced on the Genie’s Help Hub. New documents are created as private (is_public: false) and are not pushed to the Genie’s knowledge base automatically. Publishing is a separate action through the knowledge-base update path. Pass id to update an existing branded document. Omit id to create a new one.

string

required

Must be "genie-documents"

string

required

Must be "save"

object

required

Show properties

string

required

The Genie UUID. The document is linked to this Genie on save.

string

required

The document template key. One of "faq", "how-to", or "one-pager". Must match the template used during generation.

string

required

Document title shown in the knowledge library and on the Help Hub.

array

required

Ordered content sections. At least one section is required. Maximum 40 sections.

Show item properties

string

Section heading. Headings that end with ? are automatically indexed as questions on the Help Hub.

string

Section body text. Maximum 12,000 characters per section.

string

UUID of an existing branded document to update. When omitted a new document is created.

string

Optional subtitle shown below the title on the Help Hub guide card.

string

Optional format variant key (e.g. "compact") passed through for client-side rendering. Not interpreted by the server.

string

Optional plain-text description of the document’s focus, stored in metadata.

string[]

UUIDs of the knowledge-base documents used as source material during generation. Stored in metadata for reference. Maximum 50 IDs.

object

The saved document row.

Show properties

string

Document UUID.

string

Document title.

string

Owner user ID.

string

Always "genie-document" for documents saved through this action.

boolean

Always false on save. Publish separately through the knowledge-base API.

string

Always "completed" after a successful save.

object

Document metadata including name, description, answers (questions extracted from section headings), and the full genie_document structure.

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

boolean

true when a new document was created; false when an existing document was updated.

const response = await ApiService.invoke({
  resource: "genie-documents",
  action: "save",
  data: {
    agentId: "550e8400-e29b-41d4-a716-446655440000",
    template: "faq",
    title: "Frequently Asked Questions",
    subtitle: "Everything a new customer needs to know",
    sections: [
      {
        heading: "What are your business hours?",
        body: "We're open Monday through Friday, 9am to 5pm.",
      },
      {
        heading: "How do I get started?",
        body: "Create an account and follow the setup wizard.",
      },
    ],
    sourceDocumentIds: [
      "770e8400-e29b-41d4-a716-446655440002",
    ],
  },
});
// response.created === true → new document
// response.document.id   → UUID to use for subsequent updates

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "genie-documents",
    "action": "save",
    "data": {
      "agentId": "550e8400-e29b-41d4-a716-446655440000",
      "template": "faq",
      "title": "Frequently Asked Questions",
      "sections": [
        { "heading": "What are your business hours?", "body": "Monday–Friday, 9am–5pm." }
      ]
    }
  }'

{
  "success": true,
  "data": {
    "document": {
      "id": "990e8400-e29b-41d4-a716-446655440004",
      "name": "Frequently Asked Questions",
      "source_type": "genie-document",
      "is_public": false,
      "status": "completed",
      "created_at": "2024-06-26T10:00:00.000Z",
      "updated_at": "2024-06-26T10:00:00.000Z"
    },
    "created": true
  }
}

Section headings that end with ? are automatically extracted and stored as indexed questions. These questions appear on the Genie’s Help Hub question band when the document is published.

Auto-provision Genie Page pack

Builds or refreshes the Genie’s day-one Genie Page pack — an FAQ sheet ("faq") and an overview ("one-pager") — from its knowledge base into a private review draft. Generation never changes published documents or their files; documents the owner has edited are proposed for explicit review too. Nothing goes live until the draft is approved.

string

required

Must be "genie-documents"

string

required

Must be "auto-provision"

object

required

Show properties

string

required

The Genie UUID whose page pack to build or refresh.

boolean

Whether the request succeeded.

object

Show properties

object[]

Templates that produced content for the draft.

Show item properties

string

"faq" or "one-pager".

string

UUID of the document the draft content belongs to.

boolean

true if this is a new document, false if it refreshes an existing one.

object[]

Templates that were not drafted, and why.

Show item properties

string

"faq" or "one-pager".

string

One of:

"no-sources" — the Genie has no active knowledge sources. Any published auto-built documents are proposed for hiding in the draft.
"insufficient-knowledge" — the attached sources contain too little readable text (under 400 characters) to write from.
"no-content" — the knowledge base has nothing relevant to write this template from.

Skips are not errors — the call still succeeds. If no template produced content, no draft is written. If another run is already in progress for the Genie, the response is { "skipped": "in-progress" } (a string rather than an array) and the running job picks up the latest knowledge changes in a follow-up pass. A generation or storage failure for either template fails the whole call with INTERNAL_ERROR, the error message names the failing template and cause, and no draft is written.

const response = await ApiService.invoke({
  resource: "genie-documents",
  action: "auto-provision",
  data: {
    agentId: "a1b2c3d4-0000-0000-0000-000000000001",
  },
});

curl -X POST https://api.helpgenie.ai/v1 \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "genie-documents",
    "action": "auto-provision",
    "data": {
      "agentId": "a1b2c3d4-0000-0000-0000-000000000001"
    }
  }'

{
  "success": true,
  "data": {
    "provisioned": [
      {
        "template": "faq",
        "documentId": "d4e5f6a7-0000-0000-0000-000000000010",
        "created": false
      }
    ],
    "skipped": [
      { "template": "one-pager", "reason": "no-content" }
    ]
  }
}

Templates

Template	Key	Description
FAQ Sheet	`"faq"`	6–12 question-and-answer pairs written in the customer’s voice. Each section heading is the question; the body is a direct answer.
How-To Guide	`"how-to"`	Step-by-step walkthrough with a short intro, ordered sections, and an optional next-steps section.
One-Pager	`"one-pager"`	Concise 4–6 section overview covering what the business offers, who it is for, and the key things a customer should know.

Error codes

Code	Status	Description
`VALIDATION_ERROR`	400	Missing required fields (`agentId`, `template`, `title`, `sections`, `documentIds`), invalid template key, no sections supplied, or trying to save a non-branded document
`NOT_FOUND`	404	Specified document `id` not found (save), or none of the source document IDs exist (generate)
`UNAUTHORIZED`	401	Access to the Genie or document is denied
`INTERNAL_ERROR`	500	Document generation failed, returned no content (`generate`), or storage upload failed. For `auto-provision`, the message names each failing template and its cause

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Generate document

Save document

Auto-provision Genie Page pack

Templates

Error codes

​Generate document

​Save document

​Auto-provision Genie Page pack

​Templates

​Error codes

Generate document

Save document

Auto-provision Genie Page pack

Templates

Error codes