List images

List images

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/images \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.app.hrizn.io/v1/public/images', 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/images', 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/images",
  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": [
    {
      "image_id": "2c9c5b1e-6d0d-4c74-9c8f-3b1e0a5d8f21",
      "generation_id": "7a3f2e10-1b2c-4d5e-8f90-abcdef123456",
      "status": "complete",
      "image_url": "https://assets.app.hrizn.io/public/media-library/8f1c.../7a3f2e10.jpg",
      "error": null,
      "source": "ai",
      "alt_text": "Red Toyota RAV4 Hybrid parked outside a dealership at sunset",
      "title": "Red RAV4 Hybrid at Sunset",
      "caption": "A red RAV4 Hybrid in front of a modern dealership at golden hour.",
      "description": "Representative render of a red RAV4 Hybrid for a landing page hero.",
      "tags": ["ai", "rav4"],
      "width": 1376,
      "height": 768,
      "aspect_ratio": "16:9",
      "created_at": "2026-09-06T14:28:00.000Z",
      "updated_at": "2026-09-06T14:28:31.000Z",
      "generated_at": "2026-09-06T14:28:27.609Z",
      "generation": {
        "prompt": "A red Toyota RAV4 hybrid parked in front of a modern dealership at golden hour",
        "generation_prompt": "Photorealistic red Toyota RAV4 Hybrid, three-quarter front view, ...",
        "disclaimer": "Representative image. Actual vehicle may vary."
      },
      "article_id": null,
      "parent_image_id": null,
      "variants": []
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null,
    "total_count": 1
  }
}

GET

images

List images

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/images \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.app.hrizn.io/v1/public/images', 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/images', 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/images",
  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": [
    {
      "image_id": "2c9c5b1e-6d0d-4c74-9c8f-3b1e0a5d8f21",
      "generation_id": "7a3f2e10-1b2c-4d5e-8f90-abcdef123456",
      "status": "complete",
      "image_url": "https://assets.app.hrizn.io/public/media-library/8f1c.../7a3f2e10.jpg",
      "error": null,
      "source": "ai",
      "alt_text": "Red Toyota RAV4 Hybrid parked outside a dealership at sunset",
      "title": "Red RAV4 Hybrid at Sunset",
      "caption": "A red RAV4 Hybrid in front of a modern dealership at golden hour.",
      "description": "Representative render of a red RAV4 Hybrid for a landing page hero.",
      "tags": ["ai", "rav4"],
      "width": 1376,
      "height": 768,
      "aspect_ratio": "16:9",
      "created_at": "2026-09-06T14:28:00.000Z",
      "updated_at": "2026-09-06T14:28:31.000Z",
      "generated_at": "2026-09-06T14:28:27.609Z",
      "generation": {
        "prompt": "A red Toyota RAV4 hybrid parked in front of a modern dealership at golden hour",
        "generation_prompt": "Photorealistic red Toyota RAV4 Hybrid, three-quarter front view, ...",
        "disclaimer": "Representative image. Actual vehicle may vary."
      },
      "article_id": null,
      "parent_image_id": null,
      "variants": []
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null,
    "total_count": 1
  }
}

Returns the site’s Media Library images, newest first. This covers every source — AI-generated (ai), uploaded (upload), OEM stock (oem), reference images (reference), and social-platform cuts (social_variant). Each row is a full Image minus variants; call Get image for a specific asset when you need its social variant sizes. In-flight and failed AI generations are placeholder rows and are hidden by default. Pass status=generating or status=error to see them. Scope required: images:read

Query parameters

string

One of ai, upload, oem, reference, social_variant. Omit for all.

string

One of generating, complete, error. Omit for finished images only.

string

Only images attached to this content item (UUID).

string

Only images carrying this tag.

string

Substring match on alt text, title, and description.

integer

default:"20"

Page size, 1–100.

string

Opaque cursor from a previous page’s pagination.next_cursor.

Example

curl "https://api.app.hrizn.io/v1/public/images?source=ai&tag=rav4&limit=10" \
  -H "X-API-Key: hzk_your_key_here"

const res = await fetch(
  "https://api.app.hrizn.io/v1/public/images?source=ai&tag=rav4&limit=10",
  { headers: { "X-API-Key": "hzk_your_key_here" } },
);
const { data, pagination } = await res.json();

import requests

response = requests.get(
    "https://api.app.hrizn.io/v1/public/images",
    headers={"X-API-Key": "hzk_your_key_here"},
    params={"source": "ai", "tag": "rav4", "limit": 10},
)
images = response.json()["data"]

{
  "data": [
    {
      "image_id": "2c9c5b1e-6d0d-4c74-9c8f-3b1e0a5d8f21",
      "generation_id": "7a3f2e10-1b2c-4d5e-8f90-abcdef123456",
      "status": "complete",
      "image_url": "https://assets.app.hrizn.io/public/media-library/8f1c.../7a3f2e10.jpg",
      "error": null,
      "source": "ai",
      "alt_text": "Red Toyota RAV4 Hybrid parked outside a dealership at sunset",
      "title": "Red RAV4 Hybrid at Sunset",
      "caption": "A red RAV4 Hybrid in front of a modern dealership at golden hour.",
      "description": "Representative render of a red RAV4 Hybrid for a landing page hero.",
      "tags": ["ai", "rav4"],
      "width": 1376,
      "height": 768,
      "aspect_ratio": "16:9",
      "created_at": "2026-09-06T14:28:00.000Z",
      "updated_at": "2026-09-06T14:28:31.000Z",
      "generated_at": "2026-09-06T14:28:27.609Z",
      "generation": {
        "prompt": "A red Toyota RAV4 hybrid parked in front of a modern dealership at golden hour",
        "generation_prompt": "Photorealistic red Toyota RAV4 Hybrid, three-quarter front view, ...",
        "disclaimer": "Representative image. Actual vehicle may vary."
      },
      "article_id": null,
      "parent_image_id": null,
      "variants": []
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null,
    "total_count": 1
  }
}

Authorizations

X-API-Key

string

header

required

Your Hrizn API key (prefix hzk_)

Query Parameters

limit

integer

default:25

Number of results per page

Required range: 1 <= x <= 100

cursor

string

Base64-encoded pagination cursor

source

enum<string>

Restrict to one asset source.

Available options:

ai,

upload,

oem,

reference,

social_variant

status

enum<string>

Generation status. Omit for finished images; generating or error surfaces placeholder rows for in-flight or failed AI generations.

Available options:

generating,

complete,

error

article_id

string<uuid>

Only images attached to this content item.

tag

string

Only images carrying this tag.

query

string

Substring match on alt text, title, and description.

Response

Paginated list of images

data

object[]

Hide child attributes

data.image_id

string<uuid>

data.generation_id

string<uuid> | null

data.status

enum<string>

Available options:

generating,

complete,

error

data.image_url

string | null

Public asset URL once status is complete.

data.error

string | null

data.source

enum<string> | null

Available options:

ai,

upload,

oem,

reference,

social_variant

data.alt_text

string | null

Accessibility text. AI images receive an AI-written value after generation.

data.title

string | null

data.caption

string | null

data.description

string | null

data.tags

string[]

data.width

integer | null

data.height

integer | null

data.aspect_ratio

string | null

Example:

"16:9"

data.created_at

string<date-time>

data.updated_at

string<date-time> | null

data.generated_at

string<date-time> | null

When the AI render finished (AI images only).

data.generation

object | null

Present for AI-generated images.

Hide child attributes

data.generation.prompt

string | null

The creative prompt supplied by the caller.

data.generation.generation_prompt

string | null

The expanded prompt Hrizn sent to the model.

data.generation.disclaimer

string | null

E-E-A-T disclaimer to display alongside the image.

data.article_id

string<uuid> | null

Content item this image is attached to, if any.

data.parent_image_id

string<uuid> | null

Set when this image is itself a social variant of another image.

data.variants

object[]

Social variant cuts of this image. Empty on list rows.

Hide child attributes

data.variants.image_id

string<uuid>

The variant's own Media Library asset id.

data.variants.preset_key

string

Social preset key (igFeedSquare, igFeedPortrait, story, xLandscape, linkedinWide).

data.variants.preset_label

string | null

data.variants.width

integer | null

data.variants.height

integer | null

data.variants.aspect_ratio

string | null

Example:

"1:1"

data.variants.image_url

string | null

data.variants.status

enum<string>

Available options:

generating,

complete,

error

pagination

object

Hide child attributes

pagination.has_more

boolean

pagination.next_cursor

string | null

pagination.total_count

integer

Last modified on September 6, 2026

Overview

IdeaClouds

Content Intelligence

Content

Content Types

Compliance

Content Tools

Inventory

Images

Market

Site

Dealership Config

Social

Webhooks

Reference

Health

Analytics

IdeaClouds

Content

Compliance

Content Tools

Inventory

Images

Market

Site

Webhooks

Content Intelligence

Reference

Social

Query parameters

Example

Authorizations

Query Parameters

Response

​Query parameters

​Example

Authorizations

Query Parameters

Response

Query parameters

Example