Skip to main content
POST
Create vehicle comparison

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

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 June 30, 2026