From 6026103b1cafa43806e4b223650de48e7ecf059d Mon Sep 17 00:00:00 2001 From: dazzatronus Date: Wed, 26 Aug 2026 14:32:20 +1000 Subject: [PATCH] docs: point the start-image guidance at options.inputSrc and the models that take one --- schemas/imagetovideoasset.yaml | 7 ++++--- schemas/videoasset.yaml | 9 +++++---- tests/smoke.cjs | 2 +- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/schemas/imagetovideoasset.yaml b/schemas/imagetovideoasset.yaml index 6ca510c..b5d42d0 100644 --- a/schemas/imagetovideoasset.yaml +++ b/schemas/imagetovideoasset.yaml @@ -2,9 +2,10 @@ ImageToVideoAsset: deprecated: true description: | **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset) - with `prompt` and `inputSrc` instead.** This type continues to function and is - internally rewritten to VideoAsset; no behaviour change for existing - integrations. + with `prompt`, a `model` that accepts a starting image, and that image in + `options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to + function and is internally rewritten to VideoAsset; no behaviour change for + existing integrations. The ImageToVideoAsset lets you create a video from an image and a text prompt. properties: diff --git a/schemas/videoasset.yaml b/schemas/videoasset.yaml index 1bb5505..90ac824 100644 --- a/schemas/videoasset.yaml +++ b/schemas/videoasset.yaml @@ -6,8 +6,9 @@ - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file. - **Generated:** set `prompt` to describe the motion. Choose a generator - with `model` and configure it with model-specific `options` (including a - starting image for image-to-video). The generated `src` is filled in + with `model` and configure it with model-specific `options`. Models that + animate a starting image take it as `options.inputSrc`; the default model + generates from the prompt alone. The generated `src` is filled in automatically. - **Both:** `src` acts as a preview placeholder while `prompt` drives generation — the video is regenerated from the prompt at render time. @@ -33,8 +34,8 @@ A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose - the generator and `options` to configure it (including a starting - image for image-to-video). + the generator and `options` to configure it. A starting image goes in + `options.inputSrc`, on the models that accept one. type: string maxLength: 4000 example: Slowly zoom out and orbit left around the object. diff --git a/tests/smoke.cjs b/tests/smoke.cjs index 160c823..dd0c7ea 100644 --- a/tests/smoke.cjs +++ b/tests/smoke.cjs @@ -251,7 +251,7 @@ async function run() { type: "video", prompt: "Camera pans right", model: "seedance-2.0", - options: { inputSrc: "https://example.com/input.jpg" }, + options: { resolution: "720p", aspectRatio: "16:9" }, }); assert.strictEqual(result.model, "seedance-2.0"); });