Quickstart

Base URL: https://api.app.hrizn.io/v1/public — all examples below use this production URL.

Get an API Key

Navigate to the Dealership Manager in the Hrizn Dashboard, select a dealership, and click the API tab. Click Create API Key, select the scopes you need, and copy the key.

The raw API key is shown only once at creation time. Store it securely.

API keys always start with the hzk_ prefix. If your key doesn’t start with hzk_, something went wrong — regenerate it from the dashboard.

Test the Connection

Verify your key works by hitting the health endpoint:

curl https://api.app.hrizn.io/v1/public/health

const res = await fetch("https://api.app.hrizn.io/v1/public/health");
const data = await res.json();

import requests

response = requests.get("https://api.app.hrizn.io/v1/public/health")
data = response.json()

$ch = curl_init("https://api.app.hrizn.io/v1/public/health");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = json_decode(curl_exec($ch));

Then fetch your site details:

curl https://api.app.hrizn.io/v1/public/site \
  -H "X-API-Key: hzk_your_key_here"

const res = await fetch("https://api.app.hrizn.io/v1/public/site", {
  headers: { "X-API-Key": "hzk_your_key_here" },
});
const { data } = await res.json();

import requests

response = requests.get(
    "https://api.app.hrizn.io/v1/public/site",
    headers={"X-API-Key": "hzk_your_key_here"},
)
data = response.json()["data"]

$ch = curl_init("https://api.app.hrizn.io/v1/public/site");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["X-API-Key: hzk_your_key_here"],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));

You should get a response like:

{
  "data": {
    "id": "8eba316f-8424-4863-8f4b-e53c4a44d2b7",
    "name": "Empire Chevrolet of Huntington",
    "vertical": "automotive",
    "domain": "https://www.shopempirechevrolet.com",
    "city": "Huntington",
    "state": "NY",
    "zip": "11743",
    "created_at": "2024-11-08T16:21:08.780217+00:00",
    "updated_at": "2026-02-27T21:11:02.638221+00:00"
  }
}

Create an IdeaCloud

Start research on a topic:

curl -X POST https://api.app.hrizn.io/v1/public/ideaclouds \
  -H "X-API-Key: hzk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "keyword": "2026 Chevrolet Equinox EV range and features" }'

const res = await fetch("https://api.app.hrizn.io/v1/public/ideaclouds", {
  method: "POST",
  headers: {
    "X-API-Key": "hzk_your_key_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ keyword: "2026 Chevrolet Equinox EV range and features" }),
});
const { data } = await res.json();

import requests

response = requests.post(
    "https://api.app.hrizn.io/v1/public/ideaclouds",
    headers={"X-API-Key": "hzk_your_key_here"},
    json={"keyword": "2026 Chevrolet Equinox EV range and features"},
)
data = response.json()["data"]

$ch = curl_init("https://api.app.hrizn.io/v1/public/ideaclouds");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        "X-API-Key: hzk_your_key_here",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(["keyword" => "2026 Chevrolet Equinox EV range and features"]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));

Response (202 Accepted):

{
  "data": {
    "id": "bd72cd59-beda-4ce5-a9a1-20acf16c9a5d",
    "status": "researching",
    "keyword": "2026 Chevrolet Equinox EV range and features"
  }
}

Poll for Completion

Check the IdeaCloud status:

curl https://api.app.hrizn.io/v1/public/ideaclouds/a1b2c3d4-... \
  -H "X-API-Key: hzk_your_key_here"

const res = await fetch(
  "https://api.app.hrizn.io/v1/public/ideaclouds/a1b2c3d4-...",
  { headers: { "X-API-Key": "hzk_your_key_here" } },
);
const { data } = await res.json();
console.log(data.status); // "researching" → "complete"

import requests

response = requests.get(
    "https://api.app.hrizn.io/v1/public/ideaclouds/a1b2c3d4-...",
    headers={"X-API-Key": "hzk_your_key_here"},
)
data = response.json()["data"]
print(data["status"])  # "researching" → "complete"

$ch = curl_init("https://api.app.hrizn.io/v1/public/ideaclouds/a1b2c3d4-...");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["X-API-Key: hzk_your_key_here"],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));
echo $data->data->status; // "researching" → "complete"

When status changes to complete, the IdeaCloud is ready.

Instead of polling, set up a webhook to receive a push notification when the IdeaCloud completes.

Generate Content

Create content from the completed IdeaCloud:

curl -X POST https://api.app.hrizn.io/v1/public/content \
  -H "X-API-Key: hzk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "ideacloud_id": "a1b2c3d4-...",
    "article_type": "basic",
    "auto_compliance": true,
    "auto_content_tools": true
  }'

const res = await fetch("https://api.app.hrizn.io/v1/public/content", {
  method: "POST",
  headers: {
    "X-API-Key": "hzk_your_key_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    ideacloud_id: "a1b2c3d4-...",
    article_type: "basic",
    auto_compliance: true,
    auto_content_tools: true,
  }),
});
const { data } = await res.json();

import requests

response = requests.post(
    "https://api.app.hrizn.io/v1/public/content",
    headers={"X-API-Key": "hzk_your_key_here"},
    json={
        "ideacloud_id": "a1b2c3d4-...",
        "article_type": "basic",
        "auto_compliance": True,
        "auto_content_tools": True,
    },
)
data = response.json()["data"]

$ch = curl_init("https://api.app.hrizn.io/v1/public/content");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        "X-API-Key: hzk_your_key_here",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "ideacloud_id" => "a1b2c3d4-...",
        "article_type" => "basic",
        "auto_compliance" => true,
        "auto_content_tools" => true,
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));

Retrieve the Content

Once the content is complete, get the HTML:

curl https://api.app.hrizn.io/v1/public/content/{id}/html \
  -H "X-API-Key: hzk_your_key_here"

const res = await fetch(
  "https://api.app.hrizn.io/v1/public/content/{id}/html",
  { headers: { "X-API-Key": "hzk_your_key_here" } },
);
const { data } = await res.json();

import requests

response = requests.get(
    "https://api.app.hrizn.io/v1/public/content/{id}/html",
    headers={"X-API-Key": "hzk_your_key_here"},
)
data = response.json()["data"]

$ch = curl_init("https://api.app.hrizn.io/v1/public/content/{id}/html");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["X-API-Key: hzk_your_key_here"],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));

Or get all components (body, SEO metadata, schemas, social snippets):

curl https://api.app.hrizn.io/v1/public/content/{id}/components \
  -H "X-API-Key: hzk_your_key_here"

const res = await fetch(
  "https://api.app.hrizn.io/v1/public/content/{id}/components",
  { headers: { "X-API-Key": "hzk_your_key_here" } },
);
const { data } = await res.json();

import requests

response = requests.get(
    "https://api.app.hrizn.io/v1/public/content/{id}/components",
    headers={"X-API-Key": "hzk_your_key_here"},
)
data = response.json()["data"]

$ch = curl_init("https://api.app.hrizn.io/v1/public/content/{id}/components");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["X-API-Key: hzk_your_key_here"],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));

You’ve completed the quickstart! You now know how to authenticate, create IdeaClouds, generate content, and retrieve the results.

What’s Next

Webhooks Path
Explore the API

Skip polling entirely by setting up real-time push notifications:

Webhooks Guide

Webhook Events

Browse all available event types.

Getting Started

Concepts

Guides

Scopes

What’s Next

Webhooks Guide

Webhook Events

Authentication

Inventory

Bulk Generation

Full Reference

​What’s Next

Webhooks Guide

Webhook Events

Authentication

Inventory

Bulk Generation

Full Reference

What’s Next