Skip to content

Point the start-image guidance at options.inputSrc and the models that take one - #133

Merged
dazzatronus merged 1 commit into
mainfrom
derk/correct-start-image-docs
Aug 27, 2026
Merged

Point the start-image guidance at options.inputSrc and the models that take one#133
dazzatronus merged 1 commit into
mainfrom
derk/correct-start-image-docs

Conversation

@dazzatronus

Copy link
Copy Markdown
Contributor

Three places in the docs point at something that does not work.

The ImageToVideoAsset deprecation notice told people to move to VideoAsset with prompt and inputSrc. inputSrc has never been a root VideoAsset property — it belongs in options — and not every video model accepts one. It now names options.inputSrc and a model that takes it.

The two VideoAsset descriptions said options includes a starting image without qualification. Only some models animate a starting image; others generate from the prompt alone.

The smoke test paired a text-to-video model with options.inputSrc. It passes either way, since the generated Zod treats options as an open object, so it was teaching the wrong thing rather than failing.

Descriptions only. No schema shapes change, so generated types and clients are unaffected.

Verify: pnpm build regenerates cleanly and all 71 smoke tests pass.

Note: merge after the registry change that stops the default video model accepting a starting image, or this documents behaviour that is not live yet.

@dazzatronus
dazzatronus merged commit 39acb30 into main Aug 27, 2026
2 checks passed
@dazzatronus
dazzatronus deleted the derk/correct-start-image-docs branch August 27, 2026 06:57
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.18.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant