fal-endpoint-types 1.3.55 → 1.3.57

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.55",
3
+ "version": "1.3.57",
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": {
@@ -3490,6 +3490,31 @@ export interface RGBColor {
3490
3490
  r?: number;
3491
3491
  }
3492
3492
 
3493
+ export interface ReturnedSpeech {
3494
+ audio?: File;
3495
+ /**
3496
+ * Outcome
3497
+ * @description speech when audio holds the file, no_speech when no window of the input has speech (or it has no audio), failed when separating a window or building the file failed. The soundtracks come back either way.
3498
+ * @enum {string}
3499
+ */
3500
+ outcome: 'speech' | 'no_speech' | 'failed';
3501
+ /**
3502
+ * Windows
3503
+ * @description Windows the input was separated in
3504
+ */
3505
+ windows: number;
3506
+ /**
3507
+ * Windows Failed
3508
+ * @description Windows whose separation failed, or whose stem could not be read
3509
+ */
3510
+ windows_failed: number;
3511
+ /**
3512
+ * Windows With Speech
3513
+ * @description Windows that held speech
3514
+ */
3515
+ windows_with_speech: number;
3516
+ }
3517
+
3493
3518
  export interface Resolution {
3494
3519
  /**
3495
3520
  * Aspect Ratio
@@ -4214,6 +4239,24 @@ export interface OCRBoundingBox {
4214
4239
  quad_boxes: BoundingBox[];
4215
4240
  }
4216
4241
 
4242
+ export interface ObjectRLE {
4243
+ /**
4244
+ * Box
4245
+ * @description Bounding box of this object's mask in normalized cxcywh coordinates.
4246
+ */
4247
+ box?: number[];
4248
+ /**
4249
+ * Object Id
4250
+ * @description The object's id, the same in every frame the object appears in.
4251
+ */
4252
+ object_id: number;
4253
+ /**
4254
+ * Rle
4255
+ * @description Run Length Encoding of this object's mask.
4256
+ */
4257
+ rle: string;
4258
+ }
4259
+
4217
4260
  export interface ObjectDescription {
4218
4261
  /**
4219
4262
  * Action
@@ -5089,6 +5132,58 @@ export interface Lighting {
5089
5132
  shadows?: string;
5090
5133
  }
5091
5134
 
5135
+ export interface KlingV4Shot {
5136
+ /**
5137
+ * Duration
5138
+ * @description Shot duration in seconds.
5139
+ * @default 5
5140
+ */
5141
+ duration?: number;
5142
+ /**
5143
+ * Prompt
5144
+ * @description The prompt for this shot.
5145
+ */
5146
+ prompt: string;
5147
+ }
5148
+
5149
+ export interface KlingV4ImageElement {
5150
+ /**
5151
+ * Frontal Image Url
5152
+ * @description The frontal image of the element (main view).
5153
+ *
5154
+ * Max file size: 30.0MB, Min width: 300px, Min height: 300px, Min aspect ratio: 0.40, Max aspect ratio: 2.50, Timeout: 20.0s
5155
+ */
5156
+ frontal_image_url: string;
5157
+ /**
5158
+ * Reference Image Urls
5159
+ * @description Additional views of the element from different angles (1-3).
5160
+ */
5161
+ reference_image_urls: string[];
5162
+ }
5163
+
5164
+ export interface KlingV4Element {
5165
+ /**
5166
+ * Frontal Image Url
5167
+ * @description The frontal image of the element (main view).
5168
+ */
5169
+ frontal_image_url?: string;
5170
+ /**
5171
+ * Reference Image Urls
5172
+ * @description Additional views of the element from different angles (1-3).
5173
+ */
5174
+ reference_image_urls?: string[];
5175
+ /**
5176
+ * Video Url
5177
+ * @description A video of the element, used instead of images (3-30s).
5178
+ */
5179
+ video_url?: string;
5180
+ /**
5181
+ * Voice Id
5182
+ * @description Voice bound to this element. Create one with https://fal.ai/models/fal-ai/kling-video/create-voice
5183
+ */
5184
+ voice_id?: string;
5185
+ }
5186
+
5092
5187
  export interface KlingV3MultiPromptElement {
5093
5188
  /**
5094
5189
  * Duration
@@ -5155,21 +5250,6 @@ export interface KlingV3ComboElementInput {
5155
5250
  voice_id?: string;
5156
5251
  }
5157
5252
 
5158
- export interface KeyframeTransition {
5159
- /**
5160
- * Duration
5161
- * @description Duration of this transition in seconds
5162
- * @default 5
5163
- */
5164
- duration?: number;
5165
- /**
5166
- * Prompt
5167
- * @description Specific prompt for this transition. Overrides the global prompt if provided.
5168
- * @example null
5169
- */
5170
- prompt?: string;
5171
- }
5172
-
5173
5253
  export interface Keyframe_1 {
5174
5254
  /**
5175
5255
  * Duration
@@ -5848,24 +5928,24 @@ export interface GrokToolsConfiguration {
5848
5928
  /**
5849
5929
  * @description xAI-managed web search; off unless enabled is set true.
5850
5930
  * @default {
5931
+ * "excluded_domains": null,
5851
5932
  * "location": null,
5933
+ * "enable_image_understanding": null,
5852
5934
  * "allowed_domains": null,
5853
- * "enabled": false,
5854
- * "excluded_domains": null,
5855
- * "enable_image_understanding": null
5935
+ * "enabled": false
5856
5936
  * }
5857
5937
  */
5858
5938
  web_search?: GrokWebSearchTool;
5859
5939
  /**
5860
5940
  * @description xAI-managed X search; off unless enabled is set true.
5861
5941
  * @default {
5862
- * "enable_image_understanding": null,
5863
5942
  * "enable_video_understanding": null,
5943
+ * "enable_image_understanding": null,
5944
+ * "from_date": null,
5864
5945
  * "to_date": null,
5865
- * "excluded_x_handles": null,
5866
5946
  * "allowed_x_handles": null,
5867
5947
  * "enabled": false,
5868
- * "from_date": null
5948
+ * "excluded_x_handles": null
5869
5949
  * }
5870
5950
  */
5871
5951
  x_search?: GrokXSearchTool;
@@ -5954,6 +6034,188 @@ export interface GenerativeShadow {
5954
6034
  opacity?: number;
5955
6035
  }
5956
6036
 
6037
+ export interface GeminiVideoPart {
6038
+ /**
6039
+ * Thought
6040
+ * @description Provider thought marker, preserved when replaying a returned conversation.
6041
+ */
6042
+ thought?: boolean;
6043
+ /**
6044
+ * Thought Signature
6045
+ * @description Opaque provider-issued thought signature. Replay it unchanged on its original part.
6046
+ */
6047
+ thought_signature?: string;
6048
+ /**
6049
+ * @description The video part discriminator. (enum property replaced by openapi-typescript)
6050
+ * @enum {string}
6051
+ */
6052
+ type: 'video';
6053
+ /**
6054
+ * Video Url
6055
+ * @description Video URL or data URI (up to 15 MB and 120 seconds), or a YouTube URL. Supported by Flash Image only.
6056
+ */
6057
+ video_url: string;
6058
+ }
6059
+
6060
+ export interface GeminiVideoMessage {
6061
+ /**
6062
+ * Parts
6063
+ * @description Ordered text, image, document, video, audio, and signature parts.
6064
+ */
6065
+ parts: (
6066
+ | GeminiTextPart
6067
+ | GeminiImagePart
6068
+ | GeminiDocumentPart
6069
+ | GeminiVideoPart
6070
+ | GeminiSignaturePart
6071
+ | GeminiAudioPart
6072
+ )[];
6073
+ /**
6074
+ * Role
6075
+ * @description Native Gemini conversation role.
6076
+ * @enum {string}
6077
+ */
6078
+ role: 'user' | 'model';
6079
+ }
6080
+
6081
+ export interface GeminiTextPart {
6082
+ /**
6083
+ * Text
6084
+ * @description Text at this position in the conversation.
6085
+ */
6086
+ text: string;
6087
+ /**
6088
+ * Thought
6089
+ * @description Provider thought marker, preserved when replaying a returned conversation.
6090
+ */
6091
+ thought?: boolean;
6092
+ /**
6093
+ * Thought Signature
6094
+ * @description Opaque provider-issued thought signature. Replay it unchanged on its original part.
6095
+ */
6096
+ thought_signature?: string;
6097
+ /**
6098
+ * @description The text part discriminator. (enum property replaced by openapi-typescript)
6099
+ * @enum {string}
6100
+ */
6101
+ type: 'text';
6102
+ }
6103
+
6104
+ export interface GeminiSignaturePart {
6105
+ /**
6106
+ * Thought
6107
+ * @description Provider thought marker, preserved when replaying a returned conversation.
6108
+ */
6109
+ thought?: boolean;
6110
+ /**
6111
+ * Thought Signature
6112
+ * @description Provider-issued signature-only part, replayed unchanged.
6113
+ */
6114
+ thought_signature: string;
6115
+ /**
6116
+ * @description The signature part discriminator. (enum property replaced by openapi-typescript)
6117
+ * @enum {string}
6118
+ */
6119
+ type: 'signature';
6120
+ }
6121
+
6122
+ export interface GeminiMessage {
6123
+ /**
6124
+ * Parts
6125
+ * @description Ordered text, image, document, and signature parts.
6126
+ */
6127
+ parts: (GeminiTextPart | GeminiImagePart | GeminiDocumentPart | GeminiSignaturePart)[];
6128
+ /**
6129
+ * Role
6130
+ * @description Native Gemini conversation role.
6131
+ * @enum {string}
6132
+ */
6133
+ role: 'user' | 'model';
6134
+ }
6135
+
6136
+ export interface GeminiImagePart {
6137
+ /**
6138
+ * Image Url
6139
+ * @description Original image URL or data URI. Replayed without resizing or re-encoding.
6140
+ */
6141
+ image_url: string;
6142
+ /**
6143
+ * Thought
6144
+ * @description Provider thought marker, preserved when replaying a returned conversation.
6145
+ */
6146
+ thought?: boolean;
6147
+ /**
6148
+ * Thought Signature
6149
+ * @description Opaque provider-issued thought signature. Replay it unchanged on its original part.
6150
+ */
6151
+ thought_signature?: string;
6152
+ /**
6153
+ * @description The image part discriminator. (enum property replaced by openapi-typescript)
6154
+ * @enum {string}
6155
+ */
6156
+ type: 'image';
6157
+ }
6158
+
6159
+ export interface GeminiDocumentPart {
6160
+ /**
6161
+ * File Url
6162
+ * @description PDF or UTF-8 plain-text document URL or data URI (up to 15 MB).
6163
+ */
6164
+ file_url: string;
6165
+ /**
6166
+ * Mime Type
6167
+ * @description The document's media type.
6168
+ * @enum {string}
6169
+ */
6170
+ mime_type: 'application/pdf' | 'text/plain';
6171
+ /**
6172
+ * Thought
6173
+ * @description Provider thought marker, preserved when replaying a returned conversation.
6174
+ */
6175
+ thought?: boolean;
6176
+ /**
6177
+ * Thought Signature
6178
+ * @description Opaque provider-issued thought signature. Replay it unchanged on its original part.
6179
+ */
6180
+ thought_signature?: string;
6181
+ /**
6182
+ * @description The document part discriminator. (enum property replaced by openapi-typescript)
6183
+ * @enum {string}
6184
+ */
6185
+ type: 'document';
6186
+ }
6187
+
6188
+ export interface GeminiConversation {
6189
+ /**
6190
+ * Messages
6191
+ * @description One complete provider conversation. Pass messages as history in the next request, retaining every signature and part.
6192
+ */
6193
+ messages: GeminiVideoMessage[];
6194
+ }
6195
+
6196
+ export interface GeminiAudioPart {
6197
+ /**
6198
+ * Audio Url
6199
+ * @description Original audio URL or data URI from a previous Flash Image request (up to 15 MB).
6200
+ */
6201
+ audio_url: string;
6202
+ /**
6203
+ * Thought
6204
+ * @description Provider thought marker, preserved when replaying a returned conversation.
6205
+ */
6206
+ thought?: boolean;
6207
+ /**
6208
+ * Thought Signature
6209
+ * @description Opaque provider-issued thought signature. Replay it unchanged on its original part.
6210
+ */
6211
+ thought_signature?: string;
6212
+ /**
6213
+ * @description The audio part discriminator. (enum property replaced by openapi-typescript)
6214
+ * @enum {string}
6215
+ */
6216
+ type: 'audio';
6217
+ }
6218
+
5957
6219
  export interface Frame {
5958
6220
  /**
5959
6221
  * URL
@@ -194,6 +194,26 @@ declare global {
194
194
  output: falEndpoints.VeedAvatarsAudioToVideoOutput;
195
195
  };
196
196
 
197
+ 'vast/eden-live-5b-video': {
198
+ input: falEndpoints.VastEdenLive5bVideoInput;
199
+ output: falEndpoints.VastEdenLive5bVideoOutput;
200
+ };
201
+
202
+ 'vast/eden-live-5b-game': {
203
+ input: falEndpoints.VastEdenLive5bGameInput;
204
+ output: falEndpoints.VastEdenLive5bGameOutput;
205
+ };
206
+
207
+ 'vast/eden-live-14b-video': {
208
+ input: falEndpoints.VastEdenLive14bVideoInput;
209
+ output: falEndpoints.VastEdenLive14bVideoOutput;
210
+ };
211
+
212
+ 'vast/eden-live-14b-game': {
213
+ input: falEndpoints.VastEdenLive14bGameInput;
214
+ output: falEndpoints.VastEdenLive14bGameOutput;
215
+ };
216
+
197
217
  'tripo3d/triposplat': {
198
218
  input: falEndpoints.Tripo3dTriposplatInput;
199
219
  output: falEndpoints.Tripo3dTriposplatOutput;
@@ -1044,6 +1064,36 @@ declare global {
1044
1064
  output: { [x in string]: any };
1045
1065
  };
1046
1066
 
1067
+ 'kling/v4/video-to-video/edit': {
1068
+ input: falEndpoints.KlingV4VideoToVideoEditInput;
1069
+ output: falEndpoints.KlingV4VideoToVideoEditOutput;
1070
+ };
1071
+
1072
+ 'kling/v4/text-to-video': {
1073
+ input: falEndpoints.KlingV4TextToVideoInput;
1074
+ output: falEndpoints.KlingV4TextToVideoOutput;
1075
+ };
1076
+
1077
+ 'kling/v4/reference-to-video': {
1078
+ input: falEndpoints.KlingV4ReferenceToVideoInput;
1079
+ output: falEndpoints.KlingV4ReferenceToVideoOutput;
1080
+ };
1081
+
1082
+ 'kling/v4/image-to-video': {
1083
+ input: falEndpoints.KlingV4ImageToVideoInput;
1084
+ output: falEndpoints.KlingV4ImageToVideoOutput;
1085
+ };
1086
+
1087
+ 'ideogram/vector/text-to-vector': {
1088
+ input: falEndpoints.IdeogramVectorTextToVectorInput;
1089
+ output: falEndpoints.IdeogramVectorTextToVectorOutput;
1090
+ };
1091
+
1092
+ 'ideogram/vector/image-to-vector': {
1093
+ input: falEndpoints.IdeogramVectorImageToVectorInput;
1094
+ output: falEndpoints.IdeogramVectorImageToVectorOutput;
1095
+ };
1096
+
1047
1097
  'ideogram/v4/trainer': {
1048
1098
  input: falEndpoints.IdeogramV4TrainerInput;
1049
1099
  output: falEndpoints.IdeogramV4TrainerOutput;
@@ -1139,6 +1189,31 @@ declare global {
1139
1189
  output: falEndpoints.Hitem3dHi3dImageTo3dOutput;
1140
1190
  };
1141
1191
 
1192
+ 'heygen/heygen-voice/turbo': {
1193
+ input: falEndpoints.HeygenHeygenVoiceTurboInput;
1194
+ output: falEndpoints.HeygenHeygenVoiceTurboOutput;
1195
+ };
1196
+
1197
+ 'heygen/heygen-voice': {
1198
+ input: falEndpoints.HeygenHeygenVoiceInput;
1199
+ output: falEndpoints.HeygenHeygenVoiceOutput;
1200
+ };
1201
+
1202
+ 'heygen/heygen-video/text-to-video': {
1203
+ input: falEndpoints.HeygenHeygenVideoTextToVideoInput;
1204
+ output: falEndpoints.HeygenHeygenVideoTextToVideoOutput;
1205
+ };
1206
+
1207
+ 'heygen/heygen-video/reference-to-video': {
1208
+ input: falEndpoints.HeygenHeygenVideoReferenceToVideoInput;
1209
+ output: falEndpoints.HeygenHeygenVideoReferenceToVideoOutput;
1210
+ };
1211
+
1212
+ 'heygen/heygen-video/image-to-video': {
1213
+ input: falEndpoints.HeygenHeygenVideoImageToVideoInput;
1214
+ output: falEndpoints.HeygenHeygenVideoImageToVideoOutput;
1215
+ };
1216
+
1142
1217
  'google/virtual-try-on': {
1143
1218
  input: falEndpoints.GoogleVirtualTryOnInput;
1144
1219
  output: falEndpoints.GoogleVirtualTryOnOutput;
@@ -1589,11 +1664,6 @@ declare global {
1589
1664
  output: falEndpoints.WanFlf2vOutput;
1590
1665
  };
1591
1666
 
1592
- 'fal-ai/wan-effects': {
1593
- input: falEndpoints.WanEffectsInput;
1594
- output: falEndpoints.WanEffectsOutput;
1595
- };
1596
-
1597
1667
  'fal-ai/wan-25-preview/text-to-video': {
1598
1668
  input: falEndpoints.Wan25PreviewTextToVideoInput;
1599
1669
  output: falEndpoints.Wan25PreviewTextToVideoOutput;
@@ -2979,46 +3049,6 @@ declare global {
2979
3049
  output: falEndpoints.Pixal3dOutput;
2980
3050
  };
2981
3051
 
2982
- 'fal-ai/pika/v2/turbo/text-to-video': {
2983
- input: falEndpoints.PikaV2TurboTextToVideoInput;
2984
- output: falEndpoints.PikaV2TurboTextToVideoOutput;
2985
- };
2986
-
2987
- 'fal-ai/pika/v2/turbo/image-to-video': {
2988
- input: falEndpoints.PikaV2TurboImageToVideoInput;
2989
- output: falEndpoints.PikaV2TurboImageToVideoOutput;
2990
- };
2991
-
2992
- 'fal-ai/pika/v2.2/text-to-video': {
2993
- input: falEndpoints.PikaV22TextToVideoInput;
2994
- output: falEndpoints.PikaV22TextToVideoOutput;
2995
- };
2996
-
2997
- 'fal-ai/pika/v2.2/pikascenes': {
2998
- input: falEndpoints.PikaV22PikascenesInput;
2999
- output: falEndpoints.PikaV22PikascenesOutput;
3000
- };
3001
-
3002
- 'fal-ai/pika/v2.2/pikaframes': {
3003
- input: falEndpoints.PikaV22PikaframesInput;
3004
- output: falEndpoints.PikaV22PikaframesOutput;
3005
- };
3006
-
3007
- 'fal-ai/pika/v2.2/image-to-video': {
3008
- input: falEndpoints.PikaV22ImageToVideoInput;
3009
- output: falEndpoints.PikaV22ImageToVideoOutput;
3010
- };
3011
-
3012
- 'fal-ai/pika/v2.1/text-to-video': {
3013
- input: falEndpoints.PikaV21TextToVideoInput;
3014
- output: falEndpoints.PikaV21TextToVideoOutput;
3015
- };
3016
-
3017
- 'fal-ai/pika/v2.1/image-to-video': {
3018
- input: falEndpoints.PikaV21ImageToVideoInput;
3019
- output: falEndpoints.PikaV21ImageToVideoOutput;
3020
- };
3021
-
3022
3052
  'fal-ai/photomaker': {
3023
3053
  input: falEndpoints.PhotomakerInput;
3024
3054
  output: falEndpoints.PhotomakerOutput;
@@ -6340,8 +6370,8 @@ declare global {
6340
6370
  };
6341
6371
 
6342
6372
  'fal-ai/fast-fooocus-sdxl/image-to-image': {
6343
- input: falEndpoints.FastFooocusSdxlImageToImageInput;
6344
- output: falEndpoints.FastFooocusSdxlImageToImageOutput;
6373
+ input: { [x in string]: any };
6374
+ output: { [x in string]: any };
6345
6375
  };
6346
6376
 
6347
6377
  'fal-ai/fast-animatediff/video-to-video': {