fal-endpoint-types 1.3.13 → 1.3.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fal-endpoint-types",
3
- "version": "1.3.13",
3
+ "version": "1.3.14",
4
4
  "description": "TypeScript types for Fal AI endpoints generated from the OpenAPI schemas.",
5
5
  "homepage": "https://github.com/rawpixel-vincent/fal-endpoint-types#readme",
6
6
  "bugs": {
@@ -1382,19 +1382,6 @@ export interface OmniVideoElementInput {
1382
1382
  reference_image_urls?: string[];
1383
1383
  }
1384
1384
 
1385
- export interface OmniImageElementInput {
1386
- /**
1387
- * Frontal Image Url
1388
- * @description The frontal image of the element (main view).
1389
- */
1390
- frontal_image_url: string;
1391
- /**
1392
- * Reference Image Urls
1393
- * @description Additional reference images from different angles. 1-3 images supported. At least one image is required.
1394
- */
1395
- reference_image_urls?: string[];
1396
- }
1397
-
1398
1385
  export interface OCRBoundingBox {
1399
1386
  /**
1400
1387
  * Quad Boxes
@@ -2667,6 +2654,19 @@ export interface Embedding {
2667
2654
  tokens?: string[];
2668
2655
  }
2669
2656
 
2657
+ export interface ElementInput {
2658
+ /**
2659
+ * Frontal Image Url
2660
+ * @description The frontal image of the element (main view). Optional.
2661
+ */
2662
+ frontal_image_url?: string;
2663
+ /**
2664
+ * Reference Image Urls
2665
+ * @description Additional reference images from different angles. 0-3 images supported. Optional.
2666
+ */
2667
+ reference_image_urls?: string[];
2668
+ }
2669
+
2670
2670
  export interface EasyControlWeight {
2671
2671
  /**
2672
2672
  * Control Method Url
@@ -31,6 +31,7 @@ export interface XaiGrokImagineVideoTextToVideoInput {
31
31
 
32
32
  export interface XaiGrokImagineVideoTextToVideoOutput {
33
33
  /**
34
+ * Video
34
35
  * @description The generated video.
35
36
  * @example {
36
37
  * "height": 720,
@@ -39,11 +40,11 @@ export interface XaiGrokImagineVideoTextToVideoOutput {
39
40
  * "fps": 24,
40
41
  * "width": 1280,
41
42
  * "file_name": "RUAbFYlssdqnbjNLmE8qP_IX7BNYGP.mp4",
42
- * "content_type": "video/mp4",
43
- * "num_frames": 145
43
+ * "num_frames": 145,
44
+ * "content_type": "video/mp4"
44
45
  * }
45
46
  */
46
- video: Components.VideoFile;
47
+ video: Components.VideoFile_1;
47
48
  }
48
49
 
49
50
  export interface XaiGrokImagineVideoImageToVideoInput {
@@ -51,6 +52,7 @@ export interface XaiGrokImagineVideoImageToVideoInput {
51
52
  * Aspect Ratio
52
53
  * @description Aspect ratio of the generated video.
53
54
  * @default auto
55
+ * @enum {string}
54
56
  */
55
57
  aspect_ratio?: 'auto' | '16:9' | '4:3' | '3:2' | '1:1' | '2:3' | '3:4' | '9:16';
56
58
  /**
@@ -82,6 +84,7 @@ export interface XaiGrokImagineVideoImageToVideoInput {
82
84
 
83
85
  export interface XaiGrokImagineVideoImageToVideoOutput {
84
86
  /**
87
+ * Video
85
88
  * @description The generated video.
86
89
  * @example {
87
90
  * "height": 720,
@@ -90,11 +93,11 @@ export interface XaiGrokImagineVideoImageToVideoOutput {
90
93
  * "fps": 24,
91
94
  * "width": 1280,
92
95
  * "file_name": "0Ci1dviuSnEyUZzBUq-_5_nu7MrAAa.mp4",
93
- * "content_type": "video/mp4",
94
- * "num_frames": 145
96
+ * "num_frames": 145,
97
+ * "content_type": "video/mp4"
95
98
  * }
96
99
  */
97
- video: Components.VideoFile;
100
+ video: Components.VideoFile_1;
98
101
  }
99
102
 
100
103
  export interface XaiGrokImagineVideoEditVideoInput {
@@ -121,6 +124,7 @@ export interface XaiGrokImagineVideoEditVideoInput {
121
124
 
122
125
  export interface XaiGrokImagineVideoEditVideoOutput {
123
126
  /**
127
+ * Video
124
128
  * @description The generated video.
125
129
  * @example {
126
130
  * "height": 720,
@@ -129,11 +133,11 @@ export interface XaiGrokImagineVideoEditVideoOutput {
129
133
  * "fps": 24,
130
134
  * "width": 1280,
131
135
  * "file_name": "EuDrZuQTW9m1phBXOsauz_EpJH3s8X.mp4",
132
- * "content_type": "video/mp4",
133
- * "num_frames": 121
136
+ * "num_frames": 121,
137
+ * "content_type": "video/mp4"
134
138
  * }
135
139
  */
136
- video: Components.VideoFile;
140
+ video: Components.VideoFile_1;
137
141
  }
138
142
 
139
143
  export interface XaiGrokImagineImageEditInput {
@@ -180,7 +184,7 @@ export interface XaiGrokImagineImageEditOutput {
180
184
  * }
181
185
  * ]
182
186
  */
183
- images: Components.ImageFile_1[];
187
+ images: Components.ImageFile[];
184
188
  /**
185
189
  * Revised Prompt
186
190
  * @description The enhanced prompt that was used to generate the image.
@@ -246,7 +250,7 @@ export interface XaiGrokImagineImageOutput {
246
250
  * }
247
251
  * ]
248
252
  */
249
- images: Components.ImageFile_1[];
253
+ images: Components.ImageFile[];
250
254
  /**
251
255
  * Revised Prompt
252
256
  * @description The enhanced prompt that was used to generate the image.
@@ -3908,65 +3912,6 @@ export interface SharedType_c3a {
3908
3912
  speakers: Components.VibeVoiceSpeaker[];
3909
3913
  }
3910
3914
 
3911
- export interface SharedType_c18 {
3912
- /**
3913
- * Aspect Ratio
3914
- * @description The aspect ratio of the generated image.
3915
- * @default 1:1
3916
- * @enum {string}
3917
- */
3918
- aspect_ratio?: '21:9' | '16:9' | '3:2' | '4:3' | '5:4' | '1:1' | '4:5' | '3:4' | '2:3' | '9:16';
3919
- /**
3920
- * Enable Web Search
3921
- * @description Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.
3922
- * @default false
3923
- */
3924
- enable_web_search?: boolean;
3925
- /**
3926
- * Limit Generations
3927
- * @description Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate.
3928
- * @default false
3929
- */
3930
- limit_generations?: boolean;
3931
- /**
3932
- * Number of Images
3933
- * @description The number of images to generate.
3934
- * @default 1
3935
- */
3936
- num_images?: number;
3937
- /**
3938
- * Output Format
3939
- * @description The format of the generated image.
3940
- * @default png
3941
- * @enum {string}
3942
- */
3943
- output_format?: 'jpeg' | 'png' | 'webp';
3944
- /**
3945
- * Prompt
3946
- * @description The text prompt to generate an image from.
3947
- * @example An action shot of a black lab swimming in an inground suburban swimming pool. The camera is placed meticulously on the water line, dividing the image in half, revealing both the dogs head above water holding a tennis ball in it's mouth, and it's paws paddling underwater.
3948
- */
3949
- prompt: string;
3950
- /**
3951
- * Resolution
3952
- * @description The resolution of the image to generate.
3953
- * @default 1K
3954
- * @enum {string}
3955
- */
3956
- resolution?: '1K' | '2K' | '4K';
3957
- /**
3958
- * Seed
3959
- * @description The seed for the random number generator.
3960
- */
3961
- seed?: number;
3962
- /**
3963
- * Sync Mode
3964
- * @description If `True`, the media will be returned as a data URI and the output data won't be available in the request history.
3965
- * @default false
3966
- */
3967
- sync_mode?: boolean;
3968
- }
3969
-
3970
3915
  export interface SharedType_bf2 {
3971
3916
  /**
3972
3917
  * Image
@@ -10135,6 +10080,75 @@ export interface SharedType_2c4 {
10135
10080
  resolution?: '720p' | '1080p';
10136
10081
  }
10137
10082
 
10083
+ export interface SharedType_2a3 {
10084
+ /**
10085
+ * Aspect Ratio
10086
+ * @description The aspect ratio of the generated image. Use "auto" to let the model decide based on the prompt.
10087
+ * @default 1:1
10088
+ */
10089
+ aspect_ratio?:
10090
+ | 'auto'
10091
+ | '21:9'
10092
+ | '16:9'
10093
+ | '3:2'
10094
+ | '4:3'
10095
+ | '5:4'
10096
+ | '1:1'
10097
+ | '4:5'
10098
+ | '3:4'
10099
+ | '2:3'
10100
+ | '9:16';
10101
+ /**
10102
+ * Enable Web Search
10103
+ * @description Enable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.
10104
+ * @default false
10105
+ */
10106
+ enable_web_search?: boolean;
10107
+ /**
10108
+ * Limit Generations
10109
+ * @description Experimental parameter to limit the number of generations from each round of prompting to 1. Set to `True` to to disregard any instructions in the prompt regarding the number of images to generate.
10110
+ * @default false
10111
+ */
10112
+ limit_generations?: boolean;
10113
+ /**
10114
+ * Number of Images
10115
+ * @description The number of images to generate.
10116
+ * @default 1
10117
+ */
10118
+ num_images?: number;
10119
+ /**
10120
+ * Output Format
10121
+ * @description The format of the generated image.
10122
+ * @default png
10123
+ * @enum {string}
10124
+ */
10125
+ output_format?: 'jpeg' | 'png' | 'webp';
10126
+ /**
10127
+ * Prompt
10128
+ * @description The text prompt to generate an image from.
10129
+ * @example An action shot of a black lab swimming in an inground suburban swimming pool. The camera is placed meticulously on the water line, dividing the image in half, revealing both the dogs head above water holding a tennis ball in it's mouth, and it's paws paddling underwater.
10130
+ */
10131
+ prompt: string;
10132
+ /**
10133
+ * Resolution
10134
+ * @description The resolution of the image to generate.
10135
+ * @default 1K
10136
+ * @enum {string}
10137
+ */
10138
+ resolution?: '1K' | '2K' | '4K';
10139
+ /**
10140
+ * Seed
10141
+ * @description The seed for the random number generator.
10142
+ */
10143
+ seed?: number;
10144
+ /**
10145
+ * Sync Mode
10146
+ * @description If `True`, the media will be returned as a data URI and the output data won't be available in the request history.
10147
+ * @default false
10148
+ */
10149
+ sync_mode?: boolean;
10150
+ }
10151
+
10138
10152
  export interface SharedType_298 {
10139
10153
  /**
10140
10154
  * Transcribed Text
@@ -34282,7 +34296,7 @@ export interface NanoBananaProEditInput extends SharedType_eac {}
34282
34296
 
34283
34297
  export interface NanoBananaProEditOutput extends SharedType_876 {}
34284
34298
 
34285
- export interface NanoBananaProInput extends SharedType_c18 {}
34299
+ export interface NanoBananaProInput extends SharedType_2a3 {}
34286
34300
 
34287
34301
  export interface NanoBananaProOutput extends SharedType_7b9 {}
34288
34302
 
@@ -49154,7 +49168,7 @@ export interface KlingImageO1Input {
49154
49168
  * }
49155
49169
  * ]
49156
49170
  */
49157
- elements?: Components.OmniImageElementInput[];
49171
+ elements?: Components.ElementInput[];
49158
49172
  /**
49159
49173
  * Image Urls
49160
49174
  * @description List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.
@@ -57291,7 +57305,7 @@ export interface GptImage1TextToImageOutput {
57291
57305
  * }
57292
57306
  * ]
57293
57307
  */
57294
- images: Components.ImageFile[];
57308
+ images: Components.ImageFile_1[];
57295
57309
  }
57296
57310
 
57297
57311
  export interface GptImage1EditImageInput {
@@ -57373,7 +57387,7 @@ export interface GptImage1EditImageOutput {
57373
57387
  * }
57374
57388
  * ]
57375
57389
  */
57376
- images: Components.ImageFile[];
57390
+ images: Components.ImageFile_1[];
57377
57391
  }
57378
57392
 
57379
57393
  export interface GptImage15EditInput {
@@ -57605,7 +57619,7 @@ export interface GptImage1MiniEditOutput {
57605
57619
  * }
57606
57620
  * ]
57607
57621
  */
57608
- images: Components.ImageFile[];
57622
+ images: Components.ImageFile_1[];
57609
57623
  }
57610
57624
 
57611
57625
  export interface GptImage1MiniInput {
@@ -57672,7 +57686,7 @@ export interface GptImage1MiniOutput {
57672
57686
  * }
57673
57687
  * ]
57674
57688
  */
57675
- images: Components.ImageFile[];
57689
+ images: Components.ImageFile_1[];
57676
57690
  }
57677
57691
 
57678
57692
  export interface GotOcrV2Input {
@@ -58022,7 +58036,7 @@ export interface Gemini3ProImagePreviewEditInput extends SharedType_eac {}
58022
58036
 
58023
58037
  export interface Gemini3ProImagePreviewEditOutput extends SharedType_876 {}
58024
58038
 
58025
- export interface Gemini3ProImagePreviewInput extends SharedType_c18 {}
58039
+ export interface Gemini3ProImagePreviewInput extends SharedType_2a3 {}
58026
58040
 
58027
58041
  export interface Gemini3ProImagePreviewOutput extends SharedType_7b9 {}
58028
58042
 
@@ -61673,9 +61687,7 @@ export interface FluxLoraDepthInput {
61673
61687
  seed?: number;
61674
61688
  /**
61675
61689
  * Sync Mode
61676
- * @description If set to true, the function will wait for the image to be generated and uploaded
61677
- * before returning the response. This will increase the latency of the function but
61678
- * it allows you to get the image directly in the response without going through the CDN.
61690
+ * @description If `True`, the media will be returned as a data URI and the output data won't be available in the request history.
61679
61691
  * @default false
61680
61692
  */
61681
61693
  sync_mode?: boolean;