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
156

#[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<ContentTypeProperty>,
    /// 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<FileNameProperty>,
    /// The size of the file in bytes.
    /// 4404019
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_size: Option<FileSizeProperty>,
    /// 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 RecoverUpscaleRequest {
    /// Target FPS for the output video. Defaults to source FPS if not specified.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_fps: Option<TargetFpsProperty>,
    /// Factor to upscale the video by (e.g. 2.0 doubles width and height)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub upscale_factor: Option<f64>,
    /// URL of the low-quality video to upscale and recover
    /// "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4"
    pub video_url: String,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct SlowMotionRequest {
    /// Factor to slow down the video by (e.g. 4 means 4x slower)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub slowdown_factor: Option<i64>,
    /// Optional factor to upscale the video by (e.g. 2.0 doubles width and height)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub upscale_factor: Option<UpscaleFactorProperty>,
    /// URL of the video to apply slow motion to
    /// "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4"
    pub video_url: String,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct StrongAIUpscaleRequest {
    /// Target FPS for the output video. Defaults to source FPS if not specified.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_fps: Option<TargetFpsProperty>,
    /// Target height of the output video
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_height: Option<i64>,
    /// Target width of the output video
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_width: Option<i64>,
    /// URL of the AI-generated video to upscale
    /// "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4"
    pub video_url: 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)]
pub struct VideoUpscaleOutput {
    /// The upscaled video file
    /// {"url":"https://v3.fal.media/files/penguin/ztj_LB4gQlW6HIfVs8zX4_upscaled.mp4"}
    pub video: File,
}

#[derive(Debug, Serialize, Deserialize, Default)]
pub struct VideoUpscaleRequest {
    /// Target FPS for frame interpolation. If set, frame interpolation will be enabled.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_fps: Option<TargetFpsProperty>,
    /// Factor to upscale the video by (e.g. 2.0 doubles width and height)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub upscale_factor: Option<f64>,
    /// URL of the video to upscale
    /// "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4"
    pub video_url: String,
}

#[derive(Debug, Serialize, Deserialize, smart_default::SmartDefault)]
#[allow(non_camel_case_types)]
pub enum ContentTypeProperty {
    #[default]
    String(String),
    Null(serde_json::Value),
}

#[derive(Debug, Serialize, Deserialize, smart_default::SmartDefault)]
#[allow(non_camel_case_types)]
pub enum FileNameProperty {
    #[default]
    String(String),
    Null(serde_json::Value),
}

#[derive(Debug, Serialize, Deserialize, smart_default::SmartDefault)]
#[allow(non_camel_case_types)]
pub enum FileSizeProperty {
    #[default]
    Integer(i64),
    Null(serde_json::Value),
}

#[derive(Debug, Serialize, Deserialize, smart_default::SmartDefault)]
#[allow(non_camel_case_types)]
pub enum TargetFpsProperty {
    #[default]
    Integer(i64),
    Null(serde_json::Value),
}

#[derive(Debug, Serialize, Deserialize, smart_default::SmartDefault)]
#[allow(non_camel_case_types)]
pub enum UpscaleFactorProperty {
    #[default]
    Number(f64),
    Null(serde_json::Value),
}

/// Topaz Video Upscale
///
/// Category: video-to-video
///
///
///
/// Upscale AI-generated videos for maximum detail generation and preservation.
///
/// Uses Rhea-1 model specifically designed for AI-generated content. This model always internally
/// upscales to 4x the input size, then scales to the target resolution.
pub fn v4x_generative_upscale(
    params: StrongAIUpscaleRequest,
) -> FalRequest<StrongAIUpscaleRequest, VideoUpscaleOutput> {
    FalRequest::new("fal-ai/topaz/upscale/4x-generative-upscale", params)
}