Hanzo
OpenapiTemplate

Returns one starter kit: the caller org's own by that slug, else the public…

Returns one starter kit: the caller org's own by that slug, else the public catalog's.

GET /v1/template/{slug}

Addresshttps://api.hanzo.ai/v1/template/{slug}
MethodGET
Operationget_template_by_slug
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one starter kit: the caller org's own by that slug, else the public catalog's. A slug another org owns reads as not found.

Request

1 field.

FieldInTypeRequiredDescription
slugpathstringyesSlug is the starter kit to act on, from the path.

Response

StatusBodyMeaning
200StarterKitok

200 body — 19 fields.

FieldInTypeAlwaysDescription
categorybodystringgroups the kit in the gallery browser ("Portfolio", "SaaS")
demobodystringlive demo (<slug>.hanzo.app), when deployed
descriptionbodystringthe browse-card blurb
featuresbodystring[]the highlights the card lists, at most 32
frameworkbodystringthe stack the kit is built on ("Next.js 14.2 + TS")
orgbodystringowner of a PRIVATE template; empty in the public catalog
previewbodystringthe still image the browse card renders
ratingbodynumberRating is public-gallery curation, on the same terms as Tier: catalog-only, never accepted from a request, absent on a customer's own kit.
slugbodystringthe kit's identity — lowercase alphanumeric with dashes, max 40
sourcebodystringthe repository the kit is forked from
tierbodyintegerTier is public-gallery curation, carried verbatim from the embedded catalog.
titlebodystringdisplay name
useCasebodystringwhat the kit is for, in a phrase
variantsbodyVariant[]the shapes this template ships in
variants[].frameworkbodystringonly when it differs from the template's
variants[].idbodystringselector, unique within the template ("react", "grid-3-fluid")
variants[].kindbodystringthe axis it varies: format | page | theme
variants[].labelbodystringhuman label for the picker
variants[].sourcebodystringthe repository this shape is forked from; the synthesized default shape carries the template's own

Failure carries the platform error shape — see Errors.

Examples

hanzo templates get <slug>

Template API · All Hanzo APIs · Interactive reference

How is this guide?

On this page