Skip to main content
GET
/
reference
/
component-types
List component types
curl --request GET \
  --url https://api.app.hrizn.io/v1/public/reference/component-types \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "component_types": {
      "Body": "Main article content",
      "SeoMetadata": "SEO meta tags",
      "PageSlugs": "URL slugs",
      "PostTags": "Content tags",
      "BlogCategories": "Category assignments",
      "SearchIntent": "Search intent analysis",
      "FacebookSnip": "Facebook social snippet",
      "TwitterSnip": "Twitter social snippet",
      "InstagramSnip": "Instagram social snippet",
      "GoogleBusinessSnip": "Google Business snippet",
      "VideoScript": "Video script",
      "ArticleSchema": "Article JSON-LD schema",
      "AuthorSchema": "Author JSON-LD schema",
      "OrganizationSchema": "Organization JSON-LD schema",
      "VehicleListingSchema": "Vehicle JSON-LD schema",
      "FaqSchema": "FAQ JSON-LD schema",
      "EventSchema": "Event JSON-LD schema",
      "QaPageSchema": "QA Page JSON-LD schema",
      "WebPageSchema": "WebPage JSON-LD schema",
      "WebSiteSchema": "WebSite JSON-LD schema",
      "BreadcrumbSchema": "BreadcrumbList JSON-LD schema",
      "LayoutHtml": "Rendered page HTML with embedded styles"
    }
  }
}
Returns the types of components that can be attached to articles (body, SEO metadata, schemas, etc.). When used as a path parameter in GET /content/{id}/components/{type}, the type is case-insensitive.
The reference endpoint returns PascalCase keys (e.g. Body, SeoMetadata), but component API responses (e.g. GET /content/{id}/components) use camelCase (e.g. body, seoMetadata). Both formats are accepted as path parameters due to case-insensitivity.
Type (API response)Type (reference key)Description
bodyBodyMain article content (markdown)
seoMetadataSeoMetadataSEO meta tags
pageSlugsPageSlugsURL slugs
postTagsPostTagsContent tags
blogCategoriesBlogCategoriesCategory assignments
searchIntentSearchIntentSearch intent analysis
videoScriptVideoScriptVideo script
Type (API response)Type (reference key)Description
layout_htmlLayoutHtmlRendered page HTML with embedded CSS — the full visual layout output from the page builder
Type (API response)Type (reference key)Description
facebookSnipFacebookSnipFacebook social snippet
twitterSnipTwitterSnipTwitter/X social snippet
instagramSnipInstagramSnipInstagram social snippet
googleBusinessSnipGoogleBusinessSnipGoogle Business snippet
Type (API response)Type (reference key)Description
articleSchemaArticleSchemaArticle JSON-LD schema
authorSchemaAuthorSchemaAuthor JSON-LD schema
organizationSchemaOrganizationSchemaOrganization JSON-LD schema
vehicleListingSchemaVehicleListingSchemaVehicle JSON-LD schema
faqSchemaFaqSchemaFAQ JSON-LD schema
eventSchemaEventSchemaEvent JSON-LD schema
qaPageSchemaQaPageSchemaQA Page JSON-LD schema
webPageSchemaWebPageSchemaWebPage JSON-LD schema
webSiteSchemaWebSiteSchemaWebSite JSON-LD schema
breadcrumbSchemaBreadcrumbSchemaBreadcrumbList JSON-LD schema
The layout_html component contains the complete, self-contained HTML document produced by the visual page builder. Unlike the body component which stores the design JSON and raw content, layout_html stores the rendered HTML output with all CSS in a <style> block — ready to embed directly in a CMS or webpage. It is created or updated whenever a user saves or exports content in the visual editor.
{
  "data": {
    "component_types": {
      "Body": "Main article content",
      "SeoMetadata": "SEO meta tags",
      "PageSlugs": "URL slugs",
      "PostTags": "Content tags",
      "BlogCategories": "Category assignments",
      "SearchIntent": "Search intent analysis",
      "FacebookSnip": "Facebook social snippet",
      "TwitterSnip": "Twitter social snippet",
      "InstagramSnip": "Instagram social snippet",
      "GoogleBusinessSnip": "Google Business snippet",
      "VideoScript": "Video script",
      "ArticleSchema": "Article JSON-LD schema",
      "AuthorSchema": "Author JSON-LD schema",
      "OrganizationSchema": "Organization JSON-LD schema",
      "VehicleListingSchema": "Vehicle JSON-LD schema",
      "FaqSchema": "FAQ JSON-LD schema",
      "EventSchema": "Event JSON-LD schema",
      "QaPageSchema": "QA Page JSON-LD schema",
      "WebPageSchema": "WebPage JSON-LD schema",
      "WebSiteSchema": "WebSite JSON-LD schema",
      "BreadcrumbSchema": "BreadcrumbList JSON-LD schema",
      "LayoutHtml": "Rendered page HTML with embedded styles"
    }
  }
}

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Response

200 - application/json

All component types

data
object
Last modified on March 19, 2026