Skip to main content
POST
/
inventory
/
descriptions
/
batch
Generate descriptions in batch
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/inventory/descriptions/batch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "vins": [
    "<string>"
  ]
}
'
{
  "data": {
    "items": [
      {
        "vin": "1G1FY6EV0VF102843",
        "status": "generating",
        "component_id": "06e57167-6840-49db-8153-585583e9a99b"
      },
      {
        "vin": "1G1FY6EV3VF104666",
        "status": "generating",
        "component_id": "24d9a97a-b672-46d0-9eb3-eb215262e4d8"
      }
    ],
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}
Triggers AI description generation for multiple vehicles at once (1-50 VINs). Scope required: inventory:write

​
Request body

​
vins
array
required
Array of VINs (11-17 characters each, max 50).
{
  "data": {
    "items": [
      {
        "vin": "1G1FY6EV0VF102843",
        "status": "generating",
        "component_id": "06e57167-6840-49db-8153-585583e9a99b"
      },
      {
        "vin": "1G1FY6EV3VF104666",
        "status": "generating",
        "component_id": "24d9a97a-b672-46d0-9eb3-eb215262e4d8"
      }
    ],
    "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.batch_completed notifications instead of polling.

Authorizations

​
X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Body

application/json
​
vins
string[]
required
Required array length: 1 - 50 elements
Required string length: 11 - 17

Response

Batch accepted

​
data
object
Last modified on March 1, 2026