fal 0.3.6

A Rust crate for the fal.ai API, including generated, typed functions for all public models
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

#[allow(unused_imports)]
use crate::prelude::*;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
#[allow(unused_imports)]
use std::collections::HashMap;

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct File {
    /// The mime type of the file.
    /// "image/png"
    #[serde(skip_serializing_if = "Option::is_none")]
    pub content_type: Option<String>,
    /// File data
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_data: Option<String>,
    /// The name of the file. It will be auto-generated if not provided.
    /// "z9RV14K95DvU.png"
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_name: Option<String>,
    /// The size of the file in bytes.
    /// 4404019
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_size: Option<i64>,
    /// The URL where the file can be downloaded from.
    pub url: String,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct HTTPValidationError {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub detail: Option<Vec<Option<ValidationError>>>,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct ImageToVideoRequest {
    /// URL of the image to use as the first frame
    /// "https://storage.googleapis.com/falserverless/web-examples/vidu/stylish_woman.webp"
    pub image_url: String,
    /// The movement amplitude of objects in the frame
    #[serde(skip_serializing_if = "Option::is_none")]
    pub movement_amplitude: Option<String>,
    /// Text prompt for video generation, max 1500 characters
    /// "A stylish woman walks down a Tokyo street filled with warm glowing neon and animated city signage. She wears a black leather jacket, a long red dress, and black boots, and carries a black purse."
    pub prompt: String,
    /// Random seed for generation
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seed: Option<i64>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ReferenceToVideoOutput {
    /// The generated video with consistent subjects from reference images
    /// {"url":"https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/referencevideo.mp4"}
    pub video: File,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct ReferenceToVideoRequest {
    /// The aspect ratio of the output video
    #[serde(skip_serializing_if = "Option::is_none")]
    pub aspect_ratio: Option<String>,
    /// The movement amplitude of objects in the frame
    #[serde(skip_serializing_if = "Option::is_none")]
    pub movement_amplitude: Option<String>,
    /// Text prompt for video generation, max 1500 characters
    /// "The little devil is looking at the apple on the beach and walking around it."
    pub prompt: String,
    /// URLs of the reference images to use for consistent subject appearance
    /// ["https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference1.png","https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference2.png","https://storage.googleapis.com/falserverless/web-examples/vidu/new-examples/reference3.png"]
    pub reference_image_urls: Vec<String>,
    /// Random seed for generation
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seed: Option<i64>,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct StartEndToVideoOutput {
    /// The generated transition video between start and end frames
    /// {"url":"https://storage.googleapis.com/falserverless/web-examples/vidu/2-car.mp4"}
    pub video: File,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct StartEndToVideoRequest {
    /// URL of the image to use as the last frame
    /// "https://storage.googleapis.com/falserverless/web-examples/vidu/2-carbody.png"
    pub end_image_url: String,
    /// The movement amplitude of objects in the frame
    #[serde(skip_serializing_if = "Option::is_none")]
    pub movement_amplitude: Option<String>,
    /// Text prompt for video generation, max 1500 characters
    /// "Transform the car frame into a complete vehicle."
    pub prompt: String,
    /// Random seed for generation
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seed: Option<i64>,
    /// URL of the image to use as the first frame
    /// "https://storage.googleapis.com/falserverless/web-examples/vidu/2-carchasis.png"
    pub start_image_url: String,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct TemplateToVideoOutput {
    /// The generated video using a predefined template
    /// {"url":"https://storage.googleapis.com/falserverless/web-examples/vidu/hugging.mp4"}
    pub video: File,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct TemplateToVideoRequest {
    /// The aspect ratio of the output video
    #[serde(skip_serializing_if = "Option::is_none")]
    pub aspect_ratio: Option<String>,
    /// URLs of the images to use with the template. Number of images required varies by template: 'dynasty_dress' and 'shop_frame' accept 1-2 images, 'wish_sender' requires exactly 3 images, all other templates accept only 1 image.
    /// ["https://storage.googleapis.com/falserverless/web-examples/vidu/hug.PNG"]
    pub input_image_urls: Vec<String>,
    /// Text prompt for video generation, max 1500 characters
    /// "Couple hugging each other"
    pub prompt: String,
    /// Random seed for generation
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seed: Option<i64>,
    /// AI video template to use. Pricing varies by template: Standard templates (hug, kiss, love_pose, etc.) cost 4 credits ($0.20), Premium templates (lunar_newyear, dynasty_dress, dreamy_wedding, etc.) cost 6 credits ($0.30), and Advanced templates (live_photo) cost 10 credits ($0.50).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub template: Option<String>,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct ValidationError {
    pub loc: Vec<serde_json::Value>,
    pub msg: String,
    #[serde(rename = "type")]
    pub ty: String,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct VideoOutput {
    /// The generated video
    /// {"url":"https://fal.media/files/kangaroo/gzfzC5FXvcgZegQmy90L1_output.mp4"}
    pub video: File,
}

/// Vidu Image to Video
///
/// Category: image-to-video
///
///
///
/// Vidu Reference to Video API: Generate a video with consistent subjects using reference images.
pub fn reference_to_video(
    params: ReferenceToVideoRequest,
) -> FalRequest<ReferenceToVideoRequest, ReferenceToVideoOutput> {
    FalRequest::new("fal-ai/vidu/reference-to-video", params)
}