Skip to main content
POST
/
comparisons
Create vehicle comparison
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/comparisons \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "vehicles": [
    {
      "year": 2026,
      "make": "Toyota",
      "model": "Camry",
      "trim": "XSE"
    }
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "generating",
    "article_type": "comparison",
    "title": "<string>",
    "vehicles": [
      {
        "year": 2026,
        "make": "Toyota",
        "model": "Camry",
        "trim": "XSE"
      }
    ],
    "featured_vehicle_index": 123,
    "bias_level": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "message": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Body

application/json
vehicles
object[]
required
Required array length: 2 - 5 elements
brand_voice_id
string

ID of a brand voice profile to use for tone and style

language
enum<string>
default:English
Available options:
English,
Spanish,
Mandarin Chinese,
Japanese,
Korean,
Arabic,
Farsi,
Hebrew,
French,
Tagalog,
Vietnamese,
Portuguese,
Russian
title
string

Custom title. Defaults to "Vehicle A vs Vehicle B vs ..."

Maximum string length: 500
content_length
integer

Target content length in words (200-5000). Default: 3500. Comparisons with content_length >= 2500 include data tables.

Required range: 200 <= x <= 5000

Zero-based index of the vehicle to favor in the comparison. Omit for neutral/equal treatment of all vehicles.

Required range: 0 <= x <= 2
bias_level
integer

Bias intensity toward the featured vehicle (0-100). 0 = Neutral, 25 = Subtle, 50 = Moderate (default), 75 = Strong, 100 = Maximum. Only applies when featured_vehicle_index is set.

Required range: 0 <= x <= 100

Response

Comparison generation started

data
object
Last modified on April 13, 2026