Returns the knowledge-base sections for the public center's navigation — but…
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…
GET /v1/help/categories
| Address | https://api.hanzo.ai/v1/help/categories |
| Method | GET |
| Operation | get_help_categories |
| Auth | Authorization: Bearer $HANZO_API_KEY |
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.
Request
GET /v1/help/categories takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | helpCategoryList | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | helpCategory[] | — | Data is the sections that front at least one public article. |
data[].description | body | string | — | Description is the section's blurb, or empty. |
data[].name | body | string | — | Name is the section's name, and the value an article's category matches. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, HelpApi } from 'hanzoai';
const api = new HelpApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getHelpCategories();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import HelpApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = HelpApi(client).get_help_categories()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.HelpAPI.GetHelpCategories(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, help_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = help_api::get_help_categories(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.HelpApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new HelpApi(client).getHelpCategories();curl https://api.hanzo.ai/v1/help/categories \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches help through the help tool, which names its 4 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_help_articles"
}
}
}'How is this guide?