Overview
IdeaClouds
Content Intelligence
Content
Content Tools
Inventory
Dealership Config
GBP Posts
Webhooks
Reference
Health
IdeaClouds
Content
- GETList content
- POSTCreate content
- POSTCreate content in batch
- GETGet content details
- GETGet CMS-ready HTML
- GETGet all components
- GETGet a single component
- POSTGenerate interactive-mode content
- GETList published content
- GETGet publish data
- POSTCreate vehicle comparison
- POSTCreate model landing page
- POSTCreate sales event page
Inventory
Site
Webhooks
Content Intelligence
Reference
curl --request GET \
--url https://api.app.hrizn.io/v1/public/content/{id} \
--header 'X-API-Key: <api-key>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"article_type": "basic",
"status": "generating",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"ideacloud": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"keyword": "<string>"
},
"metadata": {
"source": "<string>",
"api_key_id": "<string>",
"api_creator_label": "<string>",
"outputFormat": "standard",
"visualDesignMode": "template"
},
"components": [
{
"type": "body",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"content_intent": "<string>",
"target_audience": "<string>",
"funnel_stage": "<string>",
"content_lifespan": "<string>",
"search_intent_type": "<string>"
}
}Get content details
curl --request GET \
--url https://api.app.hrizn.io/v1/public/content/{id} \
--header 'X-API-Key: <api-key>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"article_type": "basic",
"status": "generating",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"ideacloud": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"keyword": "<string>"
},
"metadata": {
"source": "<string>",
"api_key_id": "<string>",
"api_creator_label": "<string>",
"outputFormat": "standard",
"visualDesignMode": "template"
},
"components": [
{
"type": "body",
"status": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"content_intent": "<string>",
"target_audience": "<string>",
"funnel_stage": "<string>",
"content_lifespan": "<string>",
"search_intent_type": "<string>"
}
}Authorizations
Your Hrizn API key (prefix hzk_)
Path Parameters
Content ID
Response
Content details
Hide child attributes
Hide child attributes
basic, qa, expert, modellanding, comparison, salesevent, enhancedcontent, emailtemplate Content generation status
generating, complete, failed, awaiting_input Flexible metadata object. For API-created content, includes source ("public_api"), api_key_id, and api_creator_label. May also include tone, language, and other generation parameters. Visual builder content includes outputFormat ("standard" or "visual") and optionally visualDesignMode ("template", "custom", or "user-template").
Hide child attributes
Hide child attributes
Origin of content creation (e.g. "public_api")
ID of the API key used to create the content
Display label for the API key owner (e.g. "API - John Doe (john@example.com)")
Whether the content was generated as standard markdown or as a visual layout
standard, visual Design mode used for visual content (only present when outputFormat is "visual")
template, custom, user-template Hide child attributes
Hide child attributes
Component type identifier (camelCase). The path parameter is case-insensitive (e.g. body, Body, and BODY all work), but the API returns the canonical camelCase form in responses.
body, emailSubjects, seoMetadata, pageSlugs, postTags, blogCategories, searchIntent, facebookSnip, twitterSnip, instagramSnip, googleBusinessSnip, videoScript, imagePrompt, articleSchema, authorSchema, organizationSchema, vehicleListingSchema, faqSchema, eventSchema, qaPageSchema, webPageSchema, webSiteSchema, breadcrumbSchema, layout_html Content intent classification (fixed_ops, variable, general)
Target audience (in_market_buyer, service_customer, owner, general_public, enthusiast)
Buyer journey funnel stage (awareness, consideration, decision, retention)
Content lifespan type (evergreen, seasonal, time_bound)
Search intent type (informational, commercial, transactional, navigational)