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

# Get vehicle details



## OpenAPI

````yaml /openapi.yaml get /inventory/{vin}
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/{vin}:
    get:
      tags:
        - Inventory
      summary: Get vehicle details
      operationId: getVehicle
      parameters:
        - $ref: '#/components/parameters/Vin'
      responses:
        '200':
          description: Vehicle details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleDetailResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Vin:
      name: vin
      in: path
      required: true
      schema:
        type: string
        minLength: 11
        maxLength: 17
      description: Vehicle Identification Number
  schemas:
    VehicleDetailResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            vin:
              type: string
            year:
              type: integer
            make:
              type: string
            model:
              type: string
            trim:
              type: string
              nullable: true
            vehicle_type:
              type: string
              description: Vehicle condition (new or used)
            price:
              type: number
              nullable: true
            mileage:
              type: integer
              nullable: true
            exterior_color:
              type: string
              nullable: true
            interior_color:
              type: string
              nullable: true
            engine:
              type: string
              nullable: true
            transmission:
              type: string
              nullable: true
            drivetrain:
              type: string
              nullable: true
            fuel_type:
              type: string
              nullable: true
            body_style:
              type: string
              nullable: true
            stock_number:
              type: string
              nullable: true
            image_url:
              type: string
              nullable: true
              description: Primary photo URL
            images:
              type: array
              items:
                type: string
              description: All photo URLs
            ai_description:
              type: string
              nullable: true
            description_status:
              type: string
              nullable: true
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
    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'
    NotFound:
      description: Resource not found
      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_)

````