Apply a cinematic hero
apply_hero_patternReplace a design's hero section with a cinematic pattern: scrub_video (footage advances as the page SCROLLS), pointer_scrub (footage follows the CURSOR), ken_burns (a still with slow pan and zoom) or particle_bg (animated particles). Footage: the user's own upload from the media library (video_url / image_url), free stock, or — scrub_video and pointer_scrub only — a clip made for this business, which SPENDS Creative Credits and plays a free stand-in until it arrives. Call plan_hero_pattern first; send expected_credit_cost (0 for free sources) and a stable idempotency_key. A different price is refused with nothing charged. Recorded in version history; publish for visitors to see it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| density | No | particle_bg density. | |
| pattern | Yes | scrub_video = video driven by SCROLLING; pointer_scrub = video driven by the CURSOR moving across the hero; ken_burns = a still with slow pan and zoom; particle_bg = animated particles, no footage. | |
| site_id | Yes | The site to act on | |
| chapters | No | Up to 3 text slides for scrub_video / ken_burns / pointer_scrub. | |
| image_url | No | A hi-res image already in the site's media library. Never invent one. | |
| photo_url | No | commission_photo only: the photo the clip opens on. Omit to use the hero image on file. | |
| user_goal | No | Optional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details. | |
| video_url | No | An MP4 already in the site's media library (list_site_assets). Never invent one. | |
| accent_color | No | particle_bg accent, as hex. | |
| image_source | No | For ken_burns. uploaded (needs image_url) or stock. Both free. | |
| variation_id | No | The design to work on. Omit for the site's live design. | |
| video_source | No | For scrub_video / pointer_scrub. uploaded (needs video_url) and stock are free; commission_photo / commission_description make a clip for this business and cost credits (see plan_hero_pattern). | |
| chapter_title | No | particle_bg headline. | |
| chapter_eyebrow | No | ||
| idempotency_key | Yes | Stable key for this attempt; reuse it on a retry so nothing is charged twice | |
| chapter_subtitle | No | ||
| shot_description | No | Required for a commissioned clip: one or two sentences on what is in frame and how the camera moves, from what you know of the business. | |
| expected_credit_cost | Yes | 0 for free sources; for a commissioned clip, `made_for_you_clip.credits` from plan_hero_pattern |