Create vehicle comparison
Creates a vehicle comparison comparing 2-5 vehicles side-by-side.
Each vehicle must declare source=inventory (VIN) or source=catalog
(validated YMMT from /vehicle-ymmt/*). Free-text invent is rejected.
The comparison is generated asynchronously. Use the returned id with
GET /content/{id} to check status and retrieve the result.
Authorizations
Your Hrizn API key (prefix hzk_)
Body
2 - 5 elements- Option 1
- Option 2
- Option 3
Brand voice profile id (sets tone to BrandVoice:{id})
Enum tone when not using brand_voice_id. Default first brand voice or Informative.
Informative, Authoritative, Persuasive, Confident, Analytical, Empathetic, Witty, Enthusiastic, Inspiring, Motivating, Creative English, Spanish, Mandarin Chinese, Japanese, Korean, Arabic, Farsi, Hebrew, French, Tagalog, Vietnamese, Portuguese, Russian 500200 <= x <= 5000Defaults to balanced
concise, steady, balanced, substantial, in-depth Defaults to false only when content_depth is concise
Model landing only — multi-trim selection (omit when empty)
Included geos from GET /site/target-geography with priority order
Rich Text (standard) or Layouts (visual). Visual requires Layouts plan entitlement.
standard, visual When visual — custom=AI Design (default), user-template=My Template
template, custom, user-template Required when visual + user-template; from GET /layouts
Zero-based index of the vehicle to favor. Defaults to 0.
0 <= x <= 2Bias intensity toward the featured vehicle (0-100). Defaults to 50.
0 <= x <= 100Response
Comparison generation started
