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": "dac9c663-5064-4126-8047-1588d81faa7d",
    "status": "generating",
    "article_type": "comparison",
    "title": "2026 Chevrolet Silverado 1500 vs 2026 Ford F-150",
    "vehicles": [
      { "year": 2026, "make": "Chevrolet", "model": "Silverado 1500", "trim": "LT" },
      { "year": 2026, "make": "Ford", "model": "F-150", "trim": "XLT" }
    ],
    "featured_vehicle_index": 0,
    "bias_level": 50,
    "created_at": "2026-02-28T11:43:53.575412+00:00",
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}

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.

Creates and generates a vehicle comparison article for 2-5 vehicles. The comparison is generated asynchronously; use GET /content/{id} to check status and retrieve the result once complete. Scope required: content:write

​
Request body

​
vehicles
array
required
Array of 2-5 vehicles to compare. Each vehicle must include year, make, and model.
​
brand_voice_id
string
ID of a brand voice profile to use for tone and style.
​
language
string
default:"English"
Language for generated content. One of: English, Spanish, Mandarin Chinese, Japanese, Korean, Arabic, Farsi, Hebrew, French, Tagalog, Vietnamese, Portuguese, Russian.
​
title
string
Custom article title (max 500 characters). Defaults to “Vehicle A vs Vehicle B vs …”.
​
content_depth
string
default:"balanced"
Content depth preset that drives the article body. One of concise, steady, balanced, substantial, or in-depth. Comparison articles always include data tables. Replaces content_length.
​
content_length
integer
deprecated
Deprecated. Article length is now driven by content_depth; this field is accepted for backward compatibility but has no effect. Comparison articles always include data tables.
​
featured_vehicle_index
integer
Zero-based index of the vehicle to favor in the comparison (0, 1, or 2). Omit for neutral/equal treatment of all vehicles.
​
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.

​
Response

Returns 202 Accepted when the comparison starts generating: 
{
  "data": {
    "id": "dac9c663-5064-4126-8047-1588d81faa7d",
    "status": "generating",
    "article_type": "comparison",
    "title": "2026 Chevrolet Silverado 1500 vs 2026 Ford F-150",
    "vehicles": [
      { "year": 2026, "make": "Chevrolet", "model": "Silverado 1500", "trim": "LT" },
      { "year": 2026, "make": "Ford", "model": "F-150", "trim": "XLT" }
    ],
    "featured_vehicle_index": 0,
    "bias_level": 50,
    "created_at": "2026-02-28T11:43:53.575412+00:00",
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}
Content generation is asynchronous and typically completes within a few minutes. Configure webhooks to receive real-time content.completed and content.failed notifications instead of polling.
Use GET /content/{id} to poll for completion, then GET /content/{id}/html to retrieve the generated HTML.

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
deprecated

Deprecated. Article length is now driven by content_depth; this field is accepted for backward compatibility but has no effect. Comparison articles always include data tables.

Required range: 200 <= x <= 5000
​
content_depth
enum<string>

Content depth preset that drives the article body. Defaults to balanced. Replaces the legacy content_length field.

Available options:
concise,
steady,
balanced,
substantial,
in-depth
​
featured_vehicle_index
integer

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 May 1, 2026