Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions schemas/imagetovideoasset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
9 changes: 5 additions & 4 deletions schemas/videoasset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion tests/smoke.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -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");
});
Expand Down
Loading