Skip to main content
POST
Create model landing page
Creates and generates a model landing page. You must choose an explicit source: Catalog YMMT must match labels from the parent-required cascade (GET/POST /vehicle-ymmt/yearsmakesmodelstrims). Free-text invent is rejected. Generation is asynchronous; use GET /content/{id} to check status. Scope required: content:write

Request body

string
required
inventory or catalog.
string
Inventory path: vehicle VIN. Provide exactly one of vin or stock_number when source is inventory.
string
Inventory path: dealer stock number (case-insensitive). Provide exactly one of vin or stock_number when source is inventory.
integer
Required when source is catalog. Model year from /vehicle-ymmt/years.
string
Required when source is catalog. Make display label from /vehicle-ymmt/makes.
string
Required when source is catalog. Model label from /vehicle-ymmt/models.
string
Optional catalog trim label from /vehicle-ymmt/trims.
string
ID of a brand voice profile to use for tone and style (sets tone to BrandVoice:{id}).
string
Enum tone when not using a brand voice: Informative, Authoritative, Persuasive, Confident, Analytical, Empathetic, Witty, Enthusiastic, Inspiring, Motivating, Creative. Defaults to the site’s first brand voice, otherwise Informative.
string
default:"English"
Language for generated content. One of: English, Spanish, Mandarin Chinese, Japanese, Korean, Arabic, Farsi, Hebrew, French, Tagalog, Vietnamese, Portuguese, Russian.
string
Custom page title (max 500 characters). Defaults to “Year Make Model [Trim]”.
string
default:"balanced"
Content depth preset: concise, steady, balanced, substantial, or in-depth.
boolean
Optional override. Defaults to false only when content_depth is concise.
string[]
Optional multi-trim selection (from /vehicle-ymmt/trims). Omit when empty.
object[]
Optional geo targeting: [{ element_id, priority }] using ids from GET /site/target-geography.
string
default:"standard"
standard (Rich Text) or visual (Layouts). Visual requires Layouts plan entitlement.
string
When output_format=visual: custom (AI Design, default), user-template (My Template), or template (system).
uuid
Required when visual + user-template. Use GET /layouts?content_type=modellanding.
integer
deprecated
Deprecated. Accepted for backward compatibility but has no effect. Use content_depth.

Response

Returns 202 Accepted when the model landing page starts generating:

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Body

application/json
source
enum<string>
required
Available options:
inventory
vin
string
required

Exactly one of vin or stock_number

Required string length: 11 - 17
brand_voice_id
string

Brand voice profile id (sets tone to BrandVoice:{id})

tone
enum<string>

Enum tone when not using brand_voice_id. Default first brand voice or Informative.

Available options:
Informative,
Authoritative,
Persuasive,
Confident,
Analytical,
Empathetic,
Witty,
Enthusiastic,
Inspiring,
Motivating,
Creative
language
enum<string>
default:English
Available options:
English,
Spanish,
Mandarin Chinese,
Japanese,
Korean,
Arabic,
Farsi,
Hebrew,
French,
Tagalog,
Vietnamese,
Portuguese,
Russian
title
string
Maximum string length: 500
content_length
integer
deprecated
Required range: 200 <= x <= 5000
content_depth
enum<string>

Defaults to balanced

Available options:
concise,
steady,
balanced,
substantial,
in-depth
include_tables
boolean

Defaults to false only when content_depth is concise

selected_trims
string[]

Model landing only — multi-trim selection (omit when empty)

target_geo_overrides
object[]

Included geos from GET /site/target-geography with priority order

output_format
enum<string>
default:standard

Rich Text (standard) or Layouts (visual). Visual requires Layouts plan entitlement.

Available options:
standard,
visual
visual_design_mode
enum<string>

When visual — custom=AI Design (default), user-template=My Template

Available options:
template,
custom,
user-template
selected_template_id
string<uuid>

Required when visual + user-template; from GET /layouts

Response

Model landing page generation started

data
object
Last modified on July 26, 2026