Back to Tool Reference
MCP

product_video.generate

Dispatch product-video generation for a completed product design.

EffectwritesReachesoutside VaybelScopeproduct_video:writePlanGrowthRate limit10/minIdempotent

Product videos render from the design's virtual try-on (VTO) mockups, so those must exist first — generate them with mockup.generate(design_id, kinds=["vto"], audience_key=...) and wait for completion. If they're missing, this fails with a pointer.

Parameters

design_idstringRequired

UUID of the product design. Must belong to the session org for session-token callers.

channelsstring[]

Which channels to make a listing video for — any of "tiktok_shop" (1:1 square) or "etsy" (1:2 vertical). Defaults to both. One video per channel; the aspect ratio is chosen for you.

idempotency_keystring

Send the same key when retrying this exact call. A completed request replays for 24 hours without running or billing again.

callback_urlstring

An https URL that receives a signed completion event when the work finishes, so you can skip polling. See Webhooks.

Returns

handlestring

Equals design_id — product videos are design-scoped. Pass to product_video.get_generation.

video_idsstring[]

The product-video ids (one per channel).

channelsstring[]

Channels dispatched, aligned with video_ids.

status"pending"
messagestring

Describes the product_video.get_generation(design_id, wait_sec=...) contract.

Request
json
{
  "name": "product_video.generate",
  "arguments": {
    "design_id": "a26c06d3-32dc-5e33-9f63-b5d453ede96a"
  }
}