> ## 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.

# Generate descriptions (batch)

> Trigger description generation for up to 50 vehicles

Triggers AI description generation for multiple vehicles at once (1-50 VINs).

**Scope required:** `inventory:write`

## Request body

<ParamField body="vins" type="array" required>
  Array of VINs (11-17 characters each, max 50).
</ParamField>

<ResponseExample>
  ```json 202 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "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"
    }
  }
  ```
</ResponseExample>

<Tip>
  Description generation is asynchronous and typically completes within a few minutes. Configure [webhooks](/webhooks) to receive real-time `inventory.description.batch_completed` notifications instead of polling.
</Tip>


## OpenAPI

````yaml POST /inventory/descriptions/batch
openapi: 3.1.0
info:
  title: Hrizn Public API
  version: 1.2.0
  description: >
    The Hrizn Public API allows partners to programmatically create content,
    manage inventory descriptions, and integrate with the Hrizn platform.


    All endpoints are prefixed with `/public` and require an API key passed via
    the `X-API-Key` header (except the health check).
  contact:
    email: support@hrizn.io
servers:
  - url: https://api.app.hrizn.io/v1/public
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: IdeaClouds
    description: Create and manage AI-powered keyword research
  - name: Content Intelligence
    description: AI-powered content gap analysis and recommendations
  - name: Content
    description: Generate content from IdeaClouds
  - name: Compliance
    description: Run OEM compliance checks on content
  - name: Content Tools
    description: Generate SEO metadata, schemas, and social snippets
  - name: Inventory
    description: Access vehicle data and AI descriptions
  - name: Site
    description: View dealership details and configuration
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events
  - name: Reference
    description: Look up available types, scopes, and events
  - name: Social
    description: >-
      Zernio-backed social posting and reviews across all connected platforms
      (X, Facebook, Instagram, LinkedIn, Google Business Profile)
  - name: Health
    description: Health check (no authentication)
paths:
  /inventory/descriptions/batch:
    post:
      tags:
        - Inventory
      summary: Generate descriptions in batch
      description: Triggers AI description generation for multiple vehicles (1-50 VINs).
      operationId: generateDescriptionBatch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateDescriptionBatchInput'
      responses:
        '202':
          description: Batch accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescriptionBatchResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    GenerateDescriptionBatchInput:
      type: object
      required:
        - vins
      properties:
        vins:
          type: array
          items:
            type: string
            minLength: 11
            maxLength: 17
          minItems: 1
          maxItems: 50
    DescriptionBatchResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            items:
              type: array
              items:
                type: object
                properties:
                  vin:
                    type: string
                  status:
                    type: string
                  component_id:
                    type: string
                    format: uuid
                    nullable: true
                  error:
                    type: string
            message:
              type: string
              description: >-
                Informational message about async processing and webhook
                configuration
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: 'keyword: Required'
            details:
              type: object
            request_id:
              type: string
  responses:
    BadRequest:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: API key lacks required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Hrizn API key (prefix hzk_)

````