Skip to main content
GET
/
inventory
/
{vin}
/
description
Get AI description
curl --request GET \
  --url https://api.app.hrizn.io/v1/public/inventory/{vin}/description \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "vin": "1C4HJXEG5NW195712",
    "status": "complete",
    "description": null,
    "generated_at": "2026-01-29T00:06:16.020574+00:00"
  }
}
Returns the AI-generated marketing description for a vehicle, if one exists. Scope required: inventory:read

​
Path parameters

​
vin
string
required
Vehicle Identification Number (11-17 characters).
{
  "data": {
    "vin": "1C4HJXEG5NW195712",
    "status": "complete",
    "description": null,
    "generated_at": "2026-01-29T00:06:16.020574+00:00"
  }
}
If no description has been generated, status will be "not_generated" and description will be null.

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

Vehicle AI description

​
data
object
Last modified on March 1, 2026