Get image

Get image

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/images/{imageId} \
  --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/{imageId}', 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/{imageId}', 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/{imageId}",
  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": "9d2e1f30-4b5c-4d6e-8f70-1234567890ab",
    "parent_image_id": null,
    "variants": [
      {
        "image_id": "5e6f7a80-9b0c-4d1e-8f20-abcdef654321",
        "preset_key": "igFeedSquare",
        "preset_label": "Instagram / Facebook square (1:1)",
        "width": 1080,
        "height": 1080,
        "aspect_ratio": "1:1",
        "image_url": "https://assets.app.hrizn.io/public/media-library/8f1c.../5e6f7a80.jpg",
        "status": "complete"
      }
    ]
  }
}

{
  "data": {
    "image_id": "2c9c5b1e-6d0d-4c74-9c8f-3b1e0a5d8f21",
    "generation_id": "7a3f2e10-1b2c-4d5e-8f90-abcdef123456",
    "status": "generating",
    "image_url": null,
    "error": null,
    "source": "ai",
    "alt_text": null,
    "title": null,
    "caption": null,
    "description": null,
    "tags": [],
    "width": null,
    "height": null,
    "aspect_ratio": "16:9",
    "created_at": "2026-09-06T14:28:00.000Z",
    "updated_at": null,
    "generated_at": null,
    "generation": { "prompt": "A red Toyota RAV4 hybrid ...", "generation_prompt": null, "disclaimer": null },
    "article_id": null,
    "parent_image_id": null,
    "variants": []
  }
}

GET

images

{imageId}

Get image

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/images/{imageId} \
  --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/{imageId}', 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/{imageId}', 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/{imageId}",
  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": "9d2e1f30-4b5c-4d6e-8f70-1234567890ab",
    "parent_image_id": null,
    "variants": [
      {
        "image_id": "5e6f7a80-9b0c-4d1e-8f20-abcdef654321",
        "preset_key": "igFeedSquare",
        "preset_label": "Instagram / Facebook square (1:1)",
        "width": 1080,
        "height": 1080,
        "aspect_ratio": "1:1",
        "image_url": "https://assets.app.hrizn.io/public/media-library/8f1c.../5e6f7a80.jpg",
        "status": "complete"
      }
    ]
  }
}

{
  "data": {
    "image_id": "2c9c5b1e-6d0d-4c74-9c8f-3b1e0a5d8f21",
    "generation_id": "7a3f2e10-1b2c-4d5e-8f90-abcdef123456",
    "status": "generating",
    "image_url": null,
    "error": null,
    "source": "ai",
    "alt_text": null,
    "title": null,
    "caption": null,
    "description": null,
    "tags": [],
    "width": null,
    "height": null,
    "aspect_ratio": "16:9",
    "created_at": "2026-09-06T14:28:00.000Z",
    "updated_at": null,
    "generated_at": null,
    "generation": { "prompt": "A red Toyota RAV4 hybrid ...", "generation_prompt": null, "disclaimer": null },
    "article_id": null,
    "parent_image_id": null,
    "variants": []
  }
}

Returns one Media Library image: its public URL, alt text, AI-written title / caption / description, tags, dimensions, the prompt that produced it, the E-E-A-T disclaimer, the content item it is attached to, and every social variant cut (preset, size, URL). This is also the poll endpoint after Generate image. The first five fields — image_id, generation_id, status, image_url, error — are the poll contract: status is generating until the worker finishes, then complete (with image_url) or error (with error). Prefer the image.generation.completed / image.generation.failed webhooks over polling. Assets that belong to a different site return 404. Scope required: images:read (keys holding only images:write may still poll)

Path parameters

string

required

The Media Library asset UUID (the image_id returned by Generate image or List images).

Response fields

Field	Notes
`alt_text`	Accessibility text. AI images receive an AI-written value shortly after generation.
`title`, `caption`, `description`	AI-written once the alt-text pass completes; before that they echo the prompt.
`generation.prompt`	The creative prompt the caller supplied.
`generation.generation_prompt`	The expanded prompt Hrizn sent to the model.
`generation.disclaimer`	Representative-image disclaimer to show alongside the render.
`article_id`	Content item the image is attached to, if any.
`parent_image_id`	Set when this asset is itself a social variant of another image.
`variants[]`	Social cuts of this image: `preset_key`, `preset_label`, `width`, `height`, `aspect_ratio`, `image_url`.

{
  "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": "9d2e1f30-4b5c-4d6e-8f70-1234567890ab",
    "parent_image_id": null,
    "variants": [
      {
        "image_id": "5e6f7a80-9b0c-4d1e-8f20-abcdef654321",
        "preset_key": "igFeedSquare",
        "preset_label": "Instagram / Facebook square (1:1)",
        "width": 1080,
        "height": 1080,
        "aspect_ratio": "1:1",
        "image_url": "https://assets.app.hrizn.io/public/media-library/8f1c.../5e6f7a80.jpg",
        "status": "complete"
      }
    ]
  }
}

{
  "data": {
    "image_id": "2c9c5b1e-6d0d-4c74-9c8f-3b1e0a5d8f21",
    "generation_id": "7a3f2e10-1b2c-4d5e-8f90-abcdef123456",
    "status": "generating",
    "image_url": null,
    "error": null,
    "source": "ai",
    "alt_text": null,
    "title": null,
    "caption": null,
    "description": null,
    "tags": [],
    "width": null,
    "height": null,
    "aspect_ratio": "16:9",
    "created_at": "2026-09-06T14:28:00.000Z",
    "updated_at": null,
    "generated_at": null,
    "generation": { "prompt": "A red Toyota RAV4 hybrid ...", "generation_prompt": null, "disclaimer": null },
    "article_id": null,
    "parent_image_id": null,
    "variants": []
  }
}

Authorizations

X-API-Key

string

header

required

Your Hrizn API key (prefix hzk_)

Path Parameters

imageId

string<uuid>

required

Response

Image

data

object

A Media Library image. The first five fields form the async-generation poll contract and are always present; the rest describe the finished asset.

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

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

Path parameters

Response fields

Authorizations

Path Parameters

Response

​Path parameters

​Response fields

Authorizations

Path Parameters

Response

Path parameters

Response fields