Skip to content

Release SDK updates #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robinandeer merged 1 commit into from
Sep 3, 2026
Merged

Release SDK updates #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion scripts/mock
View file
Open in desktop

Large diffs are not rendered by default.

284 changes: 258 additions & 26 deletions src/resources/image-to-video.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ import { APIPromiseWithAwaitableTask, wrapAsWaitableResource } from '../lib/poll
export class ImageToVideo extends APIResource {
/**
* This endpoint will start a new task to generate a video from an image.
*
* @example
* ```ts
* const imageToVideo = await client.imageToVideo.create({
* model: 'hailuo3',
* promptImage: 'https://example.com/image.jpg',
* promptText: 'x',
* });
* ```
*/
create(
body: ImageToVideoCreateParams,
Expand Down Expand Up @@ -60,7 +69,10 @@ export type ImageToVideoCreateParams =
| ImageToVideoCreateParams.GeminiOmniFlash
| ImageToVideoCreateParams.Seedance2_5
| ImageToVideoCreateParams.GrokImagine1_5
| ImageToVideoCreateParams.Wan3;
| ImageToVideoCreateParams.Wan3
| ImageToVideoCreateParams.GeminiOmniFlash1_1
| ImageToVideoCreateParams.Wan3Prime
| ImageToVideoCreateParams.H3Max;

export declare namespace ImageToVideoCreateParams {
export interface Gen4_5 {
Expand Down Expand Up @@ -109,11 +121,16 @@ export declare namespace ImageToVideoCreateParams {
* losslessly (plus a colorimetry.json sidecar and a separate .wav when the output
* has audio); `hdr_exr_sequence` returns a .zip of half-float OpenEXR frames
* carrying the HDR signal as linear BT.2020 display light, 1.0 = 100 nits (plus a
* colorimetry.json sidecar and a separate .wav when the output has audio). Non-mp4
* formats incur an additional per-second credit surcharge: 5 credits per second
* for `prores` and `png_sequence`, and 20 credits per second for every 10-bit and
* deeper profile (including the 12-bit, 16-bit, and EXR ones), rising to 40
* credits per second when the output is larger than 4 megapixels (roughly 4K).
* colorimetry.json sidecar and a separate .wav when the output has audio);
* `hdr_exr_acescg_sequence_1_3` returns the same delivery as scene-referred ACEScg
* (inverted through the ACES 1.3 Output Transform), reading correctly with the
* stock `ACES - ACEScg` input transform in ACES-configured pipelines, with VFX
* sequence frame naming (frame.0001.exr). Non-mp4 formats incur an additional
* per-second credit surcharge: 5 credits per second for `prores` and
* `png_sequence`, and 20 credits per second for every 10-bit and deeper profile
* (including the 12-bit, 16-bit, and EXR ones), rising to 40 credits per second
* when the output is larger than 4 megapixels — that includes 1440p (2560x1440 is
* under the line, but anything larger crosses it) up through 4K.
*/
outputFormat?:
| 'mp4'
Expand All @@ -125,7 +142,9 @@ export declare namespace ImageToVideoCreateParams {
| 'hdr_pq_12bit_master'
| 'hdr_prores'
| 'hdr_png_sequence'
| 'hdr_exr_sequence';
| 'hdr_exr_sequence'
| 'hdr_exr_acescg_sequence_1_3'
| 'hdr_exr_acescg_sequence_2_0';

/**
* The ProRes profile to use. Only valid when `outputFormat` is `prores` or
Expand Down Expand Up @@ -396,9 +415,12 @@ export declare namespace ImageToVideoCreateParams {
referenceAudio?: Array<Hailuo3.ReferenceAudio>;

/**
* The output resolution. MiniMax H3 supports 768P and 2K.
* The output resolution. Hailuo 3.0 supports 768p and 2k.
*
* - `768P` - Deprecated: Use "768p" instead.
* - `2K` - Deprecated: Use "2k" instead.
*/
resolution?: '2K' | '768P';
resolution?: '768p' | '2k' | '768P' | '2K';
}

export namespace Hailuo3 {
Expand All @@ -411,7 +433,7 @@ export declare namespace ImageToVideoCreateParams {

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:audio/mp3;base64,...`) containing an encoded audio. See
* `data:audio/mp3;base64,...`, up to 5MB) containing an encoded audio. See
* [our docs](/assets/inputs#audio) on audio inputs for more information.
*/
uri: string;
Expand Down Expand Up @@ -441,8 +463,11 @@ export declare namespace ImageToVideoCreateParams {

/**
* Output quality tier. Output aspect ratio follows the input image.
*
* - `720P` - Deprecated: Use "720p" instead.
* - `1080P` - Deprecated: Use "1080p" instead.
*/
resolution?: '720P' | '1080P';
resolution?: '720p' | '1080p' | '720P' | '1080P';
}

export namespace Happyhorse1_0 {
Expand Down Expand Up @@ -557,7 +582,7 @@ export declare namespace ImageToVideoCreateParams {

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See
* `data:audio/mp3;base64,...`, up to 5MB) containing an encoded audio. See
* [our docs](/assets/inputs#audio) on audio inputs for more information.
*/
uri: string;
Expand Down Expand Up @@ -648,7 +673,7 @@ export declare namespace ImageToVideoCreateParams {

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See
* `data:audio/mp3;base64,...`, up to 5MB) containing an encoded audio. See
* [our docs](/assets/inputs#audio) on audio inputs for more information.
*/
uri: string;
Expand Down Expand Up @@ -739,7 +764,7 @@ export declare namespace ImageToVideoCreateParams {

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See
* `data:audio/mp3;base64,...`, up to 5MB) containing an encoded audio. See
* [our docs](/assets/inputs#audio) on audio inputs for more information.
*/
uri: string;
Expand Down Expand Up @@ -879,7 +904,7 @@ export declare namespace ImageToVideoCreateParams {

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See
* `data:audio/mp3;base64,...`, up to 5MB) containing an encoded audio. See
* [our docs](/assets/inputs#audio) on audio inputs for more information.
*/
uri: string;
Expand Down Expand Up @@ -954,24 +979,25 @@ export declare namespace ImageToVideoCreateParams {
duration?: number;

/**
* The resolution of the output video, as `<width>:<height>`. Use `auto_480p`,
* `auto_720p`, or `auto_1080p` to let the model pick framing at that quality tier.
* The resolution of the output video, as `<width>:<height>`. Keyframe
* image-to-video requests must use `auto_480p`, `auto_720p`, or `auto_1080p`
* because their aspect ratio follows the first frame.
*/
ratio?:
| '832:480'
| '640:480'
| '480:480'
| '480:640'
| '720:544'
| '624:624'
| '544:720'
| '480:832'
| '1280:720'
| '960:720'
| '720:720'
| '720:960'
| '1104:832'
| '960:960'
| '832:1104'
| '720:1280'
| '1920:1080'
| '1440:1080'
| '1080:1080'
| '1080:1440'
| '1648:1248'
| '1440:1440'
| '1248:1648'
| '1080:1920'
| 'auto_480p'
| 'auto_720p'
Expand Down Expand Up @@ -1022,6 +1048,212 @@ export declare namespace ImageToVideoCreateParams {
uri: string;
}
}

export interface GeminiOmniFlash1_1 {
model: 'gemini_omni_flash_1.1';

/**
* An image to use as the first frame, or an array containing a first frame and
* optional last frame.
*/
promptImage: string | Array<GeminiOmniFlash1_1.PromptImage>;

/**
* A non-empty text prompt describing how the video should evolve between the
* provided frames.
*/
promptText: string;

/**
* The duration of the output video in seconds. Use "auto" to let the model choose
* a duration. Numeric durations must be between 3 and 10 seconds.
*/
duration?: 'auto' | number;

/**
* The resolution and aspect ratio of the output video.
*/
ratio?:
| '640:360'
| '360:640'
| '1280:720'
| '720:1280'
| '1920:1080'
| '1080:1920'
| '3840:2160'
| '2160:3840';
}

export namespace GeminiOmniFlash1_1 {
export interface PromptImage {
/**
* The position of the image in the output video. "first" will use the image as the
* first frame of the video, "last" will use the image as the last frame of the
* video.
*/
position: 'first' | 'last';

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:image/png;base64,...`, up to 5MB) containing an encoded image. See
* [our docs](/assets/inputs#images) on image inputs for more information.
*/
uri: string;
}
}

export interface Wan3Prime {
model: 'wan3_prime';

/**
* An image or array of images. Use position `first`/`last` for keyframe mode, or
* omit position for reference images. The two modes cannot be mixed.
*/
promptImage: string | Array<unknown>;

/**
* A non-empty text prompt describing what should appear in the output.
*/
promptText: string;

/**
* Whether to generate audio with the video.
*/
audio?: boolean;

/**
* The number of seconds of duration for the output video.
*/
duration?: number;

/**
* The resolution of the output video, as `<width>:<height>`. Keyframe
* image-to-video requests must use `auto_480p`, `auto_720p`, or `auto_1080p`
* because their aspect ratio follows the first frame.
*/
ratio?:
| '832:480'
| '720:544'
| '624:624'
| '544:720'
| '480:832'
| '1280:720'
| '1104:832'
| '960:960'
| '832:1104'
| '720:1280'
| '1920:1080'
| '1648:1248'
| '1440:1440'
| '1248:1648'
| '1080:1920'
| 'auto_480p'
| 'auto_720p'
| 'auto_1080p';

/**
* An optional array of audio references. The total combined duration must not
* exceed 15 seconds.
*/
referenceAudio?: Array<Wan3Prime.ReferenceAudio>;

/**
* An optional array of video references. The combined duration across all video
* references must not exceed 15 seconds. See [our docs](/assets/inputs#videos) on
* video inputs for more information.
*/
referenceVideos?: Array<Wan3Prime.ReferenceVideo>;
}

export namespace Wan3Prime {
/**
* An audio reference allows the model to use the audio as additional context for
* the output.
*/
export interface ReferenceAudio {
type: 'audio';

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:audio/mp3;base64,...`, up to 5MB) containing an encoded audio. See
* [our docs](/assets/inputs#audio) on audio inputs for more information.
*/
uri: string;
}

/**
* A video reference allows the model to use the video as additional context for
* the output.
*/
export interface ReferenceVideo {
type: 'video';

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:video/mp4;base64,...`, up to 5MB) containing an encoded video. See
* [our docs](/assets/inputs#videos) on video inputs for more information.
*/
uri: string;
}
}

export interface H3Max {
model: 'h3_max';

/**
* An image to use as the first frame, or an array with a first frame and
* optionally a last frame. A last frame requires a first frame. Each image must be
* at least 256 pixels on both sides.
*/
promptImage: string | Array<H3Max.PromptImage>;

/**
* A non-empty text prompt describing what should appear in the output.
*/
promptText: string;

/**
* The number of seconds of duration for the output video.
*/
duration?: number;

/**
* How the model rewrites the prompt before generating. disabled keeps the prompt
* as written. balanced (the default) does a short rewrite. quality spends extra
* time rewriting for a stronger result.
*/
promptExpansionMode?: 'disabled' | 'balanced' | 'quality';

/**
* The output resolution. MiniMax H3 Max supports 480p and 768p.
*/
resolution?: '480p' | '768p';

/**
* If unspecified, a random number is chosen. Identical results also need
* promptExpansionMode set to disabled; balanced and quality rewrite the prompt and
* will not repeat.
*/
seed?: number;
}

export namespace H3Max {
export interface PromptImage {
/**
* The position of the image in the output video. "first" will use the image as the
* first frame of the video, "last" will use the image as the last frame of the
* video.
*/
position: 'first' | 'last';

/**
* A HTTPS URL, Runway upload URI, or base64 data URI (e.g.
* `data:image/png;base64,...`, up to 5MB) containing an encoded image. See
* [our docs](/assets/inputs#images) on image inputs for more information.
*/
uri: string;
}
}
}

export declare namespace ImageToVideo {
Expand Down
Loading
Loading