fal-endpoint-types 1.3.19 → 1.3.21

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.19",
3
+ "version": "1.3.21",
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": {
@@ -151,12 +151,6 @@ export interface VideoFile_1 {
151
151
  * @description The duration of the video
152
152
  */
153
153
  duration?: number;
154
- /**
155
- * File Data
156
- * Format: binary
157
- * @description File data
158
- */
159
- file_data?: string;
160
154
  /**
161
155
  * File Name
162
156
  * @description The name of the file. It will be auto-generated if not provided.
@@ -208,6 +202,12 @@ export interface VideoFile {
208
202
  * @description The duration of the video
209
203
  */
210
204
  duration?: number;
205
+ /**
206
+ * File Data
207
+ * Format: binary
208
+ * @description File data
209
+ */
210
+ file_data?: string;
211
211
  /**
212
212
  * File Name
213
213
  * @description The name of the file. It will be auto-generated if not provided.
@@ -779,6 +779,88 @@ export interface TextureFiles {
779
779
  roughness?: File_1;
780
780
  }
781
781
 
782
+ export interface TextRender {
783
+ /**
784
+ * Appearance Details
785
+ * @description Any other notable visual details.
786
+ */
787
+ appearance_details?: string;
788
+ /**
789
+ * Color
790
+ * @description E.g., 'red', 'blue', 'green'.
791
+ */
792
+ color: string;
793
+ /**
794
+ * Font
795
+ * @description E.g., 'realistic', 'cartoonish', 'minimalist'.
796
+ */
797
+ font: string;
798
+ /**
799
+ * Location
800
+ * @description E.g., 'center', 'top-left', 'bottom-right foreground'.
801
+ */
802
+ location: string;
803
+ /**
804
+ * Size
805
+ * @description E.g., 'small', 'medium', 'large within frame'.
806
+ */
807
+ size: string;
808
+ /**
809
+ * Text
810
+ * @description The text content.
811
+ */
812
+ text: string;
813
+ }
814
+
815
+ export interface StructuredPrompt_1 {
816
+ /** @description Details about the image aesthetics. */
817
+ aesthetics: AestheticsDetails;
818
+ /**
819
+ * Artistic Style
820
+ * @description describe specific artistic characteristics, 3 words maximum.
821
+ */
822
+ artistic_style: string;
823
+ /**
824
+ * Background Setting
825
+ * @description Describe the overall environment, setting, or background, including any notable background elements.
826
+ */
827
+ background_setting: string;
828
+ /**
829
+ * Context
830
+ * @description Provide any additional context that helps understand the image better.
831
+ */
832
+ context: string;
833
+ /** @description Details about the lighting. */
834
+ lighting: LightingDetails;
835
+ /**
836
+ * Objects
837
+ * @description List of prominent foreground/midground objects.
838
+ */
839
+ objects: ObjectDescription[];
840
+ /** @description Details about photographic characteristics. */
841
+ photographic_characteristics?: PhotographicCharacteristicsDetails;
842
+ /**
843
+ * Short Description
844
+ * @description A concise summary of the image content, 200 words maximum.
845
+ */
846
+ short_description: string;
847
+ /**
848
+ * Style Medium
849
+ * @description Identify the artistic style or medium.
850
+ */
851
+ style_medium?: string;
852
+ /**
853
+ * Subject Emotions
854
+ * @description Explicitly describe any visible emotions or expressions on subjects.
855
+ */
856
+ subject_emotions?: string;
857
+ /**
858
+ * Text Render
859
+ * @description List of text renders in the image.
860
+ */
861
+ text_render?: TextRender[];
862
+ }
863
+
782
864
  export interface StructuredPrompt {
783
865
  /** @description The aesthetics of the image to be generated. */
784
866
  aesthetics?: Aesthetics;
@@ -1149,6 +1231,23 @@ export interface ReferenceFace {
1149
1231
  image_url: string;
1150
1232
  }
1151
1233
 
1234
+ export interface RawImage {
1235
+ /**
1236
+ * Content
1237
+ * Format: binary
1238
+ */
1239
+ content: string;
1240
+ /**
1241
+ * Content Type
1242
+ * @default image/jpeg
1243
+ */
1244
+ content_type?: string;
1245
+ /** Height */
1246
+ height: number;
1247
+ /** Width */
1248
+ width: number;
1249
+ }
1250
+
1152
1251
  export interface PronunciationDictionaryLocator {
1153
1252
  /**
1154
1253
  * Pronunciation Dictionary Id
@@ -1365,6 +1464,29 @@ export interface Point {
1365
1464
  y: number;
1366
1465
  }
1367
1466
 
1467
+ export interface PhotographicCharacteristicsDetails {
1468
+ /**
1469
+ * Camera Angle
1470
+ * @description E.g., 'eye-level', 'low angle', 'high angle', 'dutch angle'.
1471
+ */
1472
+ camera_angle: string;
1473
+ /**
1474
+ * Depth Of Field
1475
+ * @description E.g., 'shallow', 'deep', 'bokeh background'.
1476
+ */
1477
+ depth_of_field: string;
1478
+ /**
1479
+ * Focus
1480
+ * @description E.g., 'sharp focus on subject', 'soft focus', 'motion blur'.
1481
+ */
1482
+ focus: string;
1483
+ /**
1484
+ * Lens Focal Length
1485
+ * @description E.g., 'wide-angle', 'telephoto', 'macro', 'fisheye'.
1486
+ */
1487
+ lens_focal_length: string;
1488
+ }
1489
+
1368
1490
  export interface PhotographicCharacteristics {
1369
1491
  /**
1370
1492
  * Camera Angle
@@ -1411,6 +1533,84 @@ export interface OCRBoundingBox {
1411
1533
  quad_boxes: BoundingBox[];
1412
1534
  }
1413
1535
 
1536
+ export interface ObjectDescription {
1537
+ /**
1538
+ * Action
1539
+ * @description Describe the action of the human.
1540
+ */
1541
+ action?: string;
1542
+ /**
1543
+ * Appearance Details
1544
+ * @description Any other notable visual details.
1545
+ */
1546
+ appearance_details?: string;
1547
+ /**
1548
+ * Clothing
1549
+ * @description Describe attire.
1550
+ */
1551
+ clothing?: string;
1552
+ /**
1553
+ * Description
1554
+ * @description Short description of the object.
1555
+ */
1556
+ description: string;
1557
+ /**
1558
+ * Expression
1559
+ * @description Describe facial expression.
1560
+ */
1561
+ expression?: string;
1562
+ /**
1563
+ * Gender
1564
+ * @description Describe the gender of the human.
1565
+ */
1566
+ gender?: string;
1567
+ /**
1568
+ * Location
1569
+ * @description E.g., 'center', 'top-left', 'bottom-right foreground'.
1570
+ */
1571
+ location: string;
1572
+ /**
1573
+ * Number Of Objects
1574
+ * @description The number of objects in the cluster.
1575
+ */
1576
+ number_of_objects?: number;
1577
+ /**
1578
+ * Orientation
1579
+ * @description Describe the orientation of the human.
1580
+ */
1581
+ orientation?: string;
1582
+ /**
1583
+ * Pose
1584
+ * @description Describe the body position.
1585
+ */
1586
+ pose?: string;
1587
+ /**
1588
+ * Relationship
1589
+ * @description Describe the relationship between the object and the other objects in the image.
1590
+ */
1591
+ relationship: string;
1592
+ /**
1593
+ * Relative Size
1594
+ * @description E.g., 'small', 'medium', 'large within frame'.
1595
+ */
1596
+ relative_size?: string;
1597
+ /**
1598
+ * Shape And Color
1599
+ * @description Describe the basic shape and dominant color.
1600
+ */
1601
+ shape_and_color?: string;
1602
+ /**
1603
+ * Skin Tone And Texture
1604
+ * @description Describe the skin tone and texture.
1605
+ */
1606
+ skin_tone_and_texture?: string;
1607
+ /**
1608
+ * Texture
1609
+ * @description E.g., 'smooth', 'rough', 'metallic', 'furry'.
1610
+ */
1611
+ texture?: string;
1612
+ }
1613
+
1414
1614
  export interface Object {
1415
1615
  /**
1416
1616
  * X Max
@@ -1538,11 +1738,6 @@ export interface ModelUrls_2 {
1538
1738
  }
1539
1739
 
1540
1740
  export interface ModelUrls_1 {
1541
- /**
1542
- * Blend
1543
- * @description Blender format 3D model
1544
- */
1545
- blend?: File_1;
1546
1741
  /**
1547
1742
  * Fbx
1548
1743
  * @description FBX format 3D model
@@ -1553,16 +1748,21 @@ export interface ModelUrls_1 {
1553
1748
  * @description GLB format 3D model
1554
1749
  */
1555
1750
  glb?: File_1;
1751
+ /**
1752
+ * Mtl
1753
+ * @description MTL material file for OBJ model
1754
+ */
1755
+ mtl?: File_1;
1556
1756
  /**
1557
1757
  * Obj
1558
1758
  * @description OBJ format 3D model
1559
1759
  */
1560
1760
  obj?: File_1;
1561
1761
  /**
1562
- * Stl
1563
- * @description STL format 3D model
1762
+ * Texture
1763
+ * @description Texture image for the 3D model
1564
1764
  */
1565
- stl?: File_1;
1765
+ texture?: File_1;
1566
1766
  /**
1567
1767
  * Usdz
1568
1768
  * @description USDZ format 3D model
@@ -1571,6 +1771,11 @@ export interface ModelUrls_1 {
1571
1771
  }
1572
1772
 
1573
1773
  export interface ModelUrls {
1774
+ /**
1775
+ * Blend
1776
+ * @description Blender format 3D model
1777
+ */
1778
+ blend?: File_1;
1574
1779
  /**
1575
1780
  * Fbx
1576
1781
  * @description FBX format 3D model
@@ -1581,21 +1786,16 @@ export interface ModelUrls {
1581
1786
  * @description GLB format 3D model
1582
1787
  */
1583
1788
  glb?: File_1;
1584
- /**
1585
- * Mtl
1586
- * @description MTL material file for OBJ model
1587
- */
1588
- mtl?: File_1;
1589
1789
  /**
1590
1790
  * Obj
1591
1791
  * @description OBJ format 3D model
1592
1792
  */
1593
1793
  obj?: File_1;
1594
1794
  /**
1595
- * Texture
1596
- * @description Texture image for the 3D model
1795
+ * Stl
1796
+ * @description STL format 3D model
1597
1797
  */
1598
- texture?: File_1;
1798
+ stl?: File_1;
1599
1799
  /**
1600
1800
  * Usdz
1601
1801
  * @description USDZ format 3D model
@@ -1900,6 +2100,24 @@ export interface LoRAInput {
1900
2100
  weight_name?: string;
1901
2101
  }
1902
2102
 
2103
+ export interface LightingDetails {
2104
+ /**
2105
+ * Conditions
2106
+ * @description E.g., 'bright daylight', 'dim indoor', 'studio lighting', 'golden hour'.
2107
+ */
2108
+ conditions: string;
2109
+ /**
2110
+ * Direction
2111
+ * @description E.g., 'front-lit', 'backlit', 'side-lit from left'.
2112
+ */
2113
+ direction: string;
2114
+ /**
2115
+ * Shadows
2116
+ * @description Describe the presence of shadows.
2117
+ */
2118
+ shadows?: string;
2119
+ }
2120
+
1903
2121
  export interface Lighting {
1904
2122
  /**
1905
2123
  * Conditions
@@ -3171,80 +3389,6 @@ export interface CameraControl {
3171
3389
  movement_value: number;
3172
3390
  }
3173
3391
 
3174
- export interface bria_fibovlm_StructuredPrompt {
3175
- /** @description The aesthetics of the image to be generated. */
3176
- aesthetics?: bria_fibovlm_Aesthetics;
3177
- /**
3178
- * Artistic Style
3179
- * @description The artistic style of the image to be generated.
3180
- */
3181
- artistic_style?: string;
3182
- /**
3183
- * Background Setting
3184
- * @description The background setting of the image to be generated.
3185
- */
3186
- background_setting?: string;
3187
- /**
3188
- * Context
3189
- * @description The context of the image to be generated.
3190
- */
3191
- context?: string;
3192
- /** @description The lighting of the image to be generated. */
3193
- lighting?: Lighting;
3194
- /**
3195
- * Objects
3196
- * @description A list of objects in the image to be generated, along with their attributes and relationships to other objects in the image.
3197
- * @default []
3198
- */
3199
- objects?: PromptObject[];
3200
- /** @description The photographic characteristics of the image to be generated. */
3201
- photographic_characteristics?: PhotographicCharacteristics;
3202
- /**
3203
- * Short Description
3204
- * @description A short description of the image to be generated.
3205
- */
3206
- short_description?: string;
3207
- /**
3208
- * Style Medium
3209
- * @description The style medium of the image to be generated.
3210
- */
3211
- style_medium?: string;
3212
- /**
3213
- * Text Render
3214
- * @description A list of text to be rendered in the image.
3215
- * @default []
3216
- */
3217
- text_render?: { [x: string]: any }[];
3218
- }
3219
-
3220
- export interface bria_fibovlm_Aesthetics {
3221
- /**
3222
- * Aesthetic Score
3223
- * @description The aesthetic score of the image.
3224
- */
3225
- aesthetic_score: string;
3226
- /**
3227
- * Color Scheme
3228
- * @description The color scheme of the image to be generated.
3229
- */
3230
- color_scheme?: string;
3231
- /**
3232
- * Composition
3233
- * @description The composition of the image to be generated.
3234
- */
3235
- composition?: string;
3236
- /**
3237
- * Mood Atmosphere
3238
- * @description The mood and atmosphere of the image to be generated.
3239
- */
3240
- mood_atmosphere?: string;
3241
- /**
3242
- * Preference Score
3243
- * @description The preference score of the image.
3244
- */
3245
- preference_score: string;
3246
- }
3247
-
3248
3392
  export interface BoxPromptBase_1 {
3249
3393
  /**
3250
3394
  * X Max
@@ -3753,6 +3897,62 @@ export interface AspectRatio {
3753
3897
  ratio?: '1:1' | '16:9' | '9:16' | '4:3' | '3:4';
3754
3898
  }
3755
3899
 
3900
+ export interface AestheticsDetails {
3901
+ /**
3902
+ * Aesthetic Score
3903
+ * @description E.g., 'very low', 'low', 'medium', 'high', 'very high'.
3904
+ */
3905
+ aesthetic_score: string;
3906
+ /**
3907
+ * Color Scheme
3908
+ * @description E.g., 'monochromatic blue', 'warm complementary colors', 'high contrast'.
3909
+ */
3910
+ color_scheme: string;
3911
+ /**
3912
+ * Composition
3913
+ * @description E.g., 'rule of thirds', 'symmetrical', 'centered', 'leading lines'.
3914
+ */
3915
+ composition: string;
3916
+ /**
3917
+ * Mood Atmosphere
3918
+ * @description E.g., 'serene', 'energetic', 'mysterious', 'joyful'.
3919
+ */
3920
+ mood_atmosphere: string;
3921
+ /**
3922
+ * Preference Score
3923
+ * @description E.g., 'very low', 'low', 'medium', 'high', 'very high'.
3924
+ */
3925
+ preference_score: string;
3926
+ }
3927
+
3928
+ export interface Aesthetics_1 {
3929
+ /**
3930
+ * Aesthetic Score
3931
+ * @description The aesthetic score of the image.
3932
+ */
3933
+ aesthetic_score: string;
3934
+ /**
3935
+ * Color Scheme
3936
+ * @description The color scheme of the image to be generated.
3937
+ */
3938
+ color_scheme?: string;
3939
+ /**
3940
+ * Composition
3941
+ * @description The composition of the image to be generated.
3942
+ */
3943
+ composition?: string;
3944
+ /**
3945
+ * Mood Atmosphere
3946
+ * @description The mood and atmosphere of the image to be generated.
3947
+ */
3948
+ mood_atmosphere?: string;
3949
+ /**
3950
+ * Preference Score
3951
+ * @description The preference score of the image.
3952
+ */
3953
+ preference_score: string;
3954
+ }
3955
+
3756
3956
  export interface Aesthetics {
3757
3957
  /**
3758
3958
  * Color Scheme
@@ -409,6 +409,11 @@ declare global {
409
409
  output: falEndpoints.XAilabNsfwOutput;
410
410
  };
411
411
 
412
+ 'fal-ai/workflow-utilities/trim-video': {
413
+ input: falEndpoints.WorkflowUtilitiesTrimVideoInput;
414
+ output: falEndpoints.WorkflowUtilitiesTrimVideoOutput;
415
+ };
416
+
412
417
  'fal-ai/workflow-utilities/interleave-video': {
413
418
  input: falEndpoints.WorkflowUtilitiesInterleaveVideoInput;
414
419
  output: falEndpoints.WorkflowUtilitiesInterleaveVideoOutput;
@@ -2034,6 +2039,11 @@ declare global {
2034
2039
  output: falEndpoints.PhotomakerOutput;
2035
2040
  };
2036
2041
 
2042
+ 'fal-ai/personaplex': {
2043
+ input: falEndpoints.PersonaplexInput;
2044
+ output: falEndpoints.PersonaplexOutput;
2045
+ };
2046
+
2037
2047
  'fal-ai/pasd': {
2038
2048
  input: falEndpoints.PasdInput;
2039
2049
  output: falEndpoints.PasdOutput;
@@ -2409,6 +2419,16 @@ declare global {
2409
2419
  output: falEndpoints.MinimaxMusicOutput;
2410
2420
  };
2411
2421
 
2422
+ 'fal-ai/meshy/v6/text-to-3d': {
2423
+ input: falEndpoints.MeshyV6TextTo3dInput;
2424
+ output: falEndpoints.MeshyV6TextTo3dOutput;
2425
+ };
2426
+
2427
+ 'fal-ai/meshy/v6/image-to-3d': {
2428
+ input: falEndpoints.MeshyV6ImageTo3dInput;
2429
+ output: falEndpoints.MeshyV6ImageTo3dOutput;
2430
+ };
2431
+
2412
2432
  'fal-ai/meshy/v6-preview/text-to-3d': {
2413
2433
  input: falEndpoints.MeshyV6PreviewTextTo3dInput;
2414
2434
  output: falEndpoints.MeshyV6PreviewTextTo3dOutput;
@@ -4479,6 +4499,11 @@ declare global {
4479
4499
  output: falEndpoints.Flux2LoraOutput;
4480
4500
  };
4481
4501
 
4502
+ 'fal-ai/flux-2/klein/realtime': {
4503
+ input: falEndpoints.Flux2KleinRealtimeInput;
4504
+ output: falEndpoints.Flux2KleinRealtimeOutput;
4505
+ };
4506
+
4482
4507
  'fal-ai/flux-2/klein/9b/edit': {
4483
4508
  input: falEndpoints.Flux2Klein9bEditInput;
4484
4509
  output: falEndpoints.Flux2Klein9bEditOutput;