Hanzo AI
OpenapiHelp

Get articles

Returns one public article by slug, with its body.

GET /v1/help/articles/{slug}

Addresshttps://api.hanzo.ai/v1/help/articles/{slug}
MethodGET
Operationget_help_articles_by_slug
AuthAuthorization: Bearer $HANZO_API_KEY

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".

Request

1 field.

FieldInTypeRequiredDescription
slugpathstringyesSlug is the article's public identifier, from the path.

Response

StatusBodyMeaning
200helpArticleok

200 body — 6 fields.

FieldInTypeAlwaysDescription
bodybodystringBody is the article's rich-text content as the author saved it.
categorybodystringCategory is the name of the knowledge-base section the article sits in, or empty when it is filed under none.
excerptbodystringExcerpt is the short summary the author wrote for listings, or empty.
slugbodystringSlug is the article's stable public identifier — the path segment it was addressed by.
titlebodystringTitle is the article's headline.
updatedAtbodyintegerUpdatedAt is the unix second the article was last written.

Failure carries the platform error shape — see Errors.

Examples

hanzo help articles get <slug>

Help API · All Hanzo APIs · Interactive reference

How is this guide?

On this page