Help
Package help is a support desk: customers file tickets, your team answers them.
Package help is a support desk: customers file tickets, your team answers them.
| Base URL | https://api.hanzo.ai |
| Operations | 4 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
help
Returns one public article by slug, with its body.
GET /v1/help/articles/{slug}
Returns one public article by slug, with its body. A missing, Draft, or internal (non-public) article is 404 — fail-closed, so this route is no existence oracle for anything beyond "published and public".
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
slug | path | string | yes | Slug is the article's public identifier, from the path. |
Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.
GET /v1/help/articles
Returns the public knowledge base: the help center's Published, publicly-visible articles as cards. The org is server-fixed and the status/is_public filter is server-set, so neither the tenant nor the visibility can be widened by the caller. A deployment with no help center answers 404.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
category | query | string | — | Category narrows the list to one knowledge-base section, matched against the article's category by exact name. |
limit | query | integer | — | Limit caps how many articles are returned. |
Returns the knowledge-base sections for the public center's navigation — but ONLY the sections that front at least one Published, public article, so an internal (agent-only) category name or description never leaks.
GET /v1/help/categories
Returns the knowledge-base sections for the public center's navigation — but ONLY the sections that front at least one Published, public article, so an internal (agent-only) category name or description never leaks. A section with no public article is invisible; a center with no public articles has no sections, which is an empty list rather than an error.
Files a customer support ticket into the public help center.
POST /v1/help/tickets
Files a customer support ticket into the public help center. It creates the ticket (status Open, source portal) with the customer's message on the description, then records that same message as the opening entry of the ticket's conversation thread; the description carries it regardless, so failing to write that entry loses nothing. Answers 201 with an opaque reference.
A deployment with no help center answers 404, one whose center has not installed the Help model answers 503, and a body over 64 KiB answers 413 — in that order, which is the order the route has always decided them in.
Request body — application/json (required)
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description is the customer's message. Optional; it becomes the ticket's description AND the opening entry of its conver |
email | string | — | Email is how the support team replies. Required; clipped at 320 characters (the RFC 5321 maximum). |
priority | string | — | Priority is Low, Medium, High or Urgent, case-insensitively. |
subject | string | — | Subject is the one-line summary of the problem. |
How is this guide?