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>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/reference/component-types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/reference/component-types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/reference/component-types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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",
      "LayoutHtml": "Rendered page HTML with embedded styles"
    }
  }
}

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>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/reference/component-types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/reference/component-types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/reference/component-types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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

Content Components

Type (API response)	Type (reference key)	Description
`body`	`Body`	Main article content (markdown)
`seoMetadata`	`SeoMetadata`	SEO meta tags
`pageSlugs`	`PageSlugs`	URL slugs
`postTags`	`PostTags`	Content tags
`blogCategories`	`BlogCategories`	Category assignments
`searchIntent`	`SearchIntent`	Search intent analysis
`videoScript`	`VideoScript`	Video script

Layout

Type (API response)	Type (reference key)	Description
`layout_html`	`LayoutHtml`	Rendered page HTML with embedded CSS — the full visual layout output from the page builder

Type (API response)	Type (reference key)	Description
`facebookSnip`	`FacebookSnip`	Facebook social snippet
`twitterSnip`	`TwitterSnip`	Twitter/X social snippet
`instagramSnip`	`InstagramSnip`	Instagram social snippet
`googleBusinessSnip`	`GoogleBusinessSnip`	Google Business snippet

JSON-LD Schemas

Type (API response)	Type (reference key)	Description
`articleSchema`	`ArticleSchema`	Article JSON-LD schema
`authorSchema`	`AuthorSchema`	Author JSON-LD schema
`organizationSchema`	`OrganizationSchema`	Organization JSON-LD schema
`vehicleListingSchema`	`VehicleListingSchema`	Vehicle JSON-LD schema
`faqSchema`	`FaqSchema`	FAQ JSON-LD schema
`eventSchema`	`EventSchema`	Event JSON-LD schema
`qaPageSchema`	`QaPageSchema`	QA Page 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",
      "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

Hide child attributes

data.component_types

object

Last modified on May 1, 2026

Overview

IdeaClouds

Content Intelligence

Content

Content Types

Compliance

Content Tools

Inventory

Market

Site

Dealership Config

Social

Webhooks

Reference

Health

Analytics

IdeaClouds

Content

Compliance

Content Tools

Inventory

Market

Site

Webhooks

Content Intelligence

Reference

Social

Authorizations

Response