Skip to main content
POST
/
inventory
/
{vin}
/
description
Generate AI description
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/inventory/{vin}/description \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "vin": "1C4HJXEG5NW195712",
    "status": "generating",
    "component_id": "239e61d6-34d0-4741-9dd1-eed56edec1ab",
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.hrizn.io/llms.txt

Use this file to discover all available pages before exploring further.

Triggers AI description generation for a specific vehicle. This upserts a description component with draft status, which kicks off the asynchronous generation pipeline. Scope required: inventory:write

​
Path parameters

​
vin
string
required
Vehicle Identification Number (11-17 characters).
{
  "data": {
    "vin": "1C4HJXEG5NW195712",
    "status": "generating",
    "component_id": "239e61d6-34d0-4741-9dd1-eed56edec1ab",
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}
Description generation is asynchronous and typically completes within a few minutes. Configure webhooks to receive real-time inventory.description.completed notifications instead of polling.

Authorizations

​
X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Path Parameters

​
vin
string
required

Vehicle Identification Number

Required string length: 11 - 17

Response

Description generation started

​
data
object
Last modified on March 1, 2026