fal-endpoint-types 1.3.8 → 1.3.10

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.8",
3
+ "version": "1.3.10",
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": {
@@ -630,6 +630,60 @@ export interface TranscriptionWord {
630
630
  type: string;
631
631
  }
632
632
 
633
+ export interface TrajectoryParameters {
634
+ /**
635
+ * Phi
636
+ * @description Vertical rotation angles (degrees) for each keyframe.
637
+ * @example [
638
+ * 0,
639
+ * -3,
640
+ * -8,
641
+ * -15,
642
+ * -20,
643
+ * -15,
644
+ * -10,
645
+ * -5,
646
+ * 0
647
+ * ]
648
+ */
649
+ phi: number[];
650
+ /**
651
+ * Radius
652
+ * @description Camera distance scaling factors for each keyframe.
653
+ * @example [
654
+ * 0,
655
+ * 0.02,
656
+ * 0.09,
657
+ * 0.16,
658
+ * 0.25,
659
+ * 0.2,
660
+ * 0.09,
661
+ * 0
662
+ * ]
663
+ */
664
+ radius: number[];
665
+ /**
666
+ * Theta
667
+ * @description Horizontal rotation angles (degrees) for each keyframe.
668
+ * @example [
669
+ * 0,
670
+ * 2,
671
+ * 8,
672
+ * 10,
673
+ * 5,
674
+ * 3,
675
+ * 0,
676
+ * -2,
677
+ * -5,
678
+ * -8,
679
+ * -5,
680
+ * -3,
681
+ * 0
682
+ * ]
683
+ */
684
+ theta: number[];
685
+ }
686
+
633
687
  export interface Trajectory {
634
688
  /**
635
689
  * X
@@ -801,6 +855,19 @@ export interface StructuredInstruction {
801
855
  text_render?: { [x: string]: any }[];
802
856
  }
803
857
 
858
+ export interface SpeechTimestamp {
859
+ /**
860
+ * End Time
861
+ * @description The end time of the speech in seconds.
862
+ */
863
+ end: number;
864
+ /**
865
+ * Start Time
866
+ * @description The start time of the speech in seconds.
867
+ */
868
+ start: number;
869
+ }
870
+
804
871
  export interface Speaker {
805
872
  /** Audio Url */
806
873
  audio_url: string;
@@ -841,80 +908,6 @@ export interface SemanticImageInput {
841
908
  reference: string;
842
909
  }
843
910
 
844
- export interface SAM3DObjectMetadata {
845
- /**
846
- * Camera Pose
847
- * @description Camera pose matrix
848
- */
849
- camera_pose?: number[][];
850
- /**
851
- * Object Index
852
- * @description Index of the object in the scene
853
- */
854
- object_index: number;
855
- /**
856
- * Rotation
857
- * @description Rotation quaternion [x, y, z, w]
858
- */
859
- rotation?: number[][];
860
- /**
861
- * Scale
862
- * @description Scale factors [sx, sy, sz]
863
- */
864
- scale?: number[][];
865
- /**
866
- * Translation
867
- * @description Translation [tx, ty, tz]
868
- */
869
- translation?: number[][];
870
- }
871
-
872
- export interface SAM3DBodyPersonMetadata {
873
- /**
874
- * Bbox
875
- * @description Bounding box [x_min, y_min, x_max, y_max]
876
- */
877
- bbox: number[];
878
- /**
879
- * Focal Length
880
- * @description Estimated focal length
881
- */
882
- focal_length: number;
883
- /**
884
- * Keypoints 2D
885
- * @description 2D keypoints [[x, y], ...] - 70 body keypoints
886
- */
887
- keypoints_2d: number[][];
888
- /**
889
- * Keypoints 3D
890
- * @description 3D keypoints [[x, y, z], ...] - 70 body keypoints in camera space
891
- */
892
- keypoints_3d?: number[][];
893
- /**
894
- * Person Id
895
- * @description Index of the person in the scene
896
- */
897
- person_id: number;
898
- /**
899
- * Pred Cam T
900
- * @description Predicted camera translation [tx, ty, tz]
901
- */
902
- pred_cam_t: number[];
903
- }
904
-
905
- export interface SAM3DBodyMetadata {
906
- /**
907
- * Num People
908
- * @description Number of people detected
909
- */
910
- num_people: number;
911
- /**
912
- * People
913
- * @description Per-person metadata
914
- */
915
- people: SAM3DBodyPersonMetadata[];
916
- }
917
-
918
911
  export interface SAM3DBodyAlignmentInfo {
919
912
  /**
920
913
  * Cropped Vertices Count
@@ -1310,7 +1303,7 @@ export interface OmniVideoElementInput {
1310
1303
  frontal_image_url: string;
1311
1304
  /**
1312
1305
  * Reference Image Urls
1313
- * @description Additional reference images from different angles. 1-3 images supported. At least one image is required.
1306
+ * @description Additional reference images from different angles. 1-4 images supported. At least one image is required.
1314
1307
  */
1315
1308
  reference_image_urls?: string[];
1316
1309
  }
@@ -1495,6 +1488,24 @@ export interface ModelUrls {
1495
1488
  usdz?: File_1;
1496
1489
  }
1497
1490
 
1491
+ export interface MaskMetadata {
1492
+ /**
1493
+ * Box
1494
+ * @description Bounding box for the mask in normalized cxcywh coordinates.
1495
+ */
1496
+ box?: number[];
1497
+ /**
1498
+ * Index
1499
+ * @description Index of the mask inside the model output.
1500
+ */
1501
+ index: number;
1502
+ /**
1503
+ * Score
1504
+ * @description Score for this mask.
1505
+ */
1506
+ score?: number;
1507
+ }
1508
+
1498
1509
  export interface LoudnormSummary {
1499
1510
  /**
1500
1511
  * Input Integrated
@@ -2410,58 +2421,6 @@ export interface File {
2410
2421
  url: string;
2411
2422
  }
2412
2423
 
2413
- export interface ExtendVideoConditioningInput {
2414
- /**
2415
- * Limit Number of Frames
2416
- * @description Whether to limit the number of frames used from the video. If True, the `max_num_frames` parameter will be used to limit the number of frames.
2417
- * @default false
2418
- */
2419
- limit_num_frames?: boolean;
2420
- /**
2421
- * Maximum Number of Frames
2422
- * @description Maximum number of frames to use from the video. If None, all frames will be used.
2423
- * @default 1441
2424
- * @example 1441
2425
- */
2426
- max_num_frames?: number;
2427
- /**
2428
- * Resample FPS
2429
- * @description Whether to resample the video to a specific FPS. If True, the `target_fps` parameter will be used to resample the video.
2430
- * @default false
2431
- */
2432
- resample_fps?: boolean;
2433
- /**
2434
- * Reverse Video
2435
- * @description Whether to reverse the video. This is useful for tasks where the video conditioning should be applied in reverse order.
2436
- * @default false
2437
- */
2438
- reverse_video?: boolean;
2439
- /**
2440
- * Start Frame Number
2441
- * @description Frame number of the video from which the conditioning starts. Must be a multiple of 8.
2442
- * @default 0
2443
- */
2444
- start_frame_num?: number;
2445
- /**
2446
- * Strength
2447
- * @description Strength of the conditioning. 0.0 means no conditioning, 1.0 means full conditioning.
2448
- * @default 1
2449
- */
2450
- strength?: number;
2451
- /**
2452
- * Target FPS
2453
- * @description Target FPS to resample the video to. Only relevant if `resample_fps` is True.
2454
- * @default 24
2455
- * @example 24
2456
- */
2457
- target_fps?: number;
2458
- /**
2459
- * Video URL
2460
- * @description URL of video to use as conditioning
2461
- */
2462
- video_url: string;
2463
- }
2464
-
2465
2424
  export interface EmotionalStrengths {
2466
2425
  /**
2467
2426
  * Afraid
@@ -2744,38 +2703,6 @@ export interface ControlNetUnion {
2744
2703
  variant?: string;
2745
2704
  }
2746
2705
 
2747
- export interface ControlNet_2 {
2748
- /**
2749
- * Conditioning Scale
2750
- * @description The scale of the control net weight. This is used to scale the control net weight
2751
- * before merging it with the base model.
2752
- * @default 1
2753
- */
2754
- conditioning_scale?: number;
2755
- /**
2756
- * Control Image Url
2757
- * @description URL of the image to be used as the control image.
2758
- */
2759
- control_image_url: string;
2760
- /**
2761
- * End Percentage
2762
- * @description The percentage of the image to end applying the controlnet in terms of the total timesteps.
2763
- * @default 1
2764
- */
2765
- end_percentage?: number;
2766
- /**
2767
- * Path
2768
- * @description URL or the path to the control net weights.
2769
- */
2770
- path: string;
2771
- /**
2772
- * Start Percentage
2773
- * @description The percentage of the image to start applying the controlnet in terms of the total timesteps.
2774
- * @default 0
2775
- */
2776
- start_percentage?: number;
2777
- }
2778
-
2779
2706
  export interface ControlNet_1 {
2780
2707
  /**
2781
2708
  * Conditioning Scale
@@ -2908,6 +2835,24 @@ export interface ControlLoraWeight {
2908
2835
  scale?: Record<string, number> | number;
2909
2836
  }
2910
2837
 
2838
+ export interface CompletionUsage {
2839
+ /**
2840
+ * Completion Tokens
2841
+ * @description Number of tokens in the completion
2842
+ */
2843
+ completion_tokens: number;
2844
+ /**
2845
+ * Prompt Tokens
2846
+ * @description Number of tokens in the prompt
2847
+ */
2848
+ prompt_tokens: number;
2849
+ /**
2850
+ * Total Tokens
2851
+ * @description Total tokens used
2852
+ */
2853
+ total_tokens: number;
2854
+ }
2855
+
2911
2856
  export interface ColorPaletteMember {
2912
2857
  /**
2913
2858
  * Color Weight
@@ -3037,56 +2982,56 @@ export interface bria_fibovlm_Aesthetics {
3037
2982
  }
3038
2983
 
3039
2984
  export interface BoxPromptBase_1 {
2985
+ /**
2986
+ * Object Id
2987
+ * @description Optional object identifier. Boxes sharing an object id refine the same object.
2988
+ */
2989
+ object_id?: number;
3040
2990
  /**
3041
2991
  * X Max
3042
- * @description X Max Coordinate of the prompt
3043
- * @default 0
2992
+ * @description X Max Coordinate of the box
3044
2993
  */
3045
2994
  x_max?: number;
3046
2995
  /**
3047
2996
  * X Min
3048
2997
  * @description X Min Coordinate of the box
3049
- * @default 0
3050
2998
  */
3051
2999
  x_min?: number;
3052
3000
  /**
3053
3001
  * Y Max
3054
- * @description Y Max Coordinate of the prompt
3055
- * @default 0
3002
+ * @description Y Max Coordinate of the box
3056
3003
  */
3057
3004
  y_max?: number;
3058
3005
  /**
3059
3006
  * Y Min
3060
3007
  * @description Y Min Coordinate of the box
3061
- * @default 0
3062
3008
  */
3063
3009
  y_min?: number;
3064
3010
  }
3065
3011
 
3066
3012
  export interface BoxPromptBase {
3067
- /**
3068
- * Object Id
3069
- * @description Optional object identifier. Boxes sharing an object id refine the same object.
3070
- */
3071
- object_id?: number;
3072
3013
  /**
3073
3014
  * X Max
3074
- * @description X Max Coordinate of the box
3015
+ * @description X Max Coordinate of the prompt
3016
+ * @default 0
3075
3017
  */
3076
3018
  x_max?: number;
3077
3019
  /**
3078
3020
  * X Min
3079
3021
  * @description X Min Coordinate of the box
3022
+ * @default 0
3080
3023
  */
3081
3024
  x_min?: number;
3082
3025
  /**
3083
3026
  * Y Max
3084
- * @description Y Max Coordinate of the box
3027
+ * @description Y Max Coordinate of the prompt
3028
+ * @default 0
3085
3029
  */
3086
3030
  y_max?: number;
3087
3031
  /**
3088
3032
  * Y Min
3089
3033
  * @description Y Min Coordinate of the box
3034
+ * @default 0
3090
3035
  */
3091
3036
  y_min?: number;
3092
3037
  }
@@ -3321,7 +3266,7 @@ export interface AudioSetting {
3321
3266
  sample_rate?: 8000 | 16000 | 22050 | 24000 | 32000 | 44100;
3322
3267
  }
3323
3268
 
3324
- export interface AudioFile_1 {
3269
+ export interface AudioFile_2 {
3325
3270
  /**
3326
3271
  * Content Type
3327
3272
  * @default audio/wav
@@ -3347,7 +3292,7 @@ export interface AudioFile_1 {
3347
3292
  url: string;
3348
3293
  }
3349
3294
 
3350
- export interface AudioFile {
3295
+ export interface AudioFile_1 {
3351
3296
  /**
3352
3297
  * Bitrate
3353
3298
  * @description The bitrate of the audio
@@ -3399,6 +3344,58 @@ export interface AudioFile {
3399
3344
  url: string;
3400
3345
  }
3401
3346
 
3347
+ export interface AudioFile {
3348
+ /**
3349
+ * Bitrate
3350
+ * @description The bitrate of the audio (e.g., '192k' or 192000)
3351
+ */
3352
+ bitrate?: string | number;
3353
+ /**
3354
+ * Channels
3355
+ * @description The number of channels in the audio
3356
+ */
3357
+ channels?: number;
3358
+ /**
3359
+ * Content Type
3360
+ * @description The mime type of the file.
3361
+ * @example image/png
3362
+ */
3363
+ content_type?: string;
3364
+ /**
3365
+ * Duration
3366
+ * @description The duration of the audio
3367
+ */
3368
+ duration?: number;
3369
+ /**
3370
+ * File Data
3371
+ * Format: binary
3372
+ * @description File data
3373
+ */
3374
+ file_data?: string;
3375
+ /**
3376
+ * File Name
3377
+ * @description The name of the file. It will be auto-generated if not provided.
3378
+ * @example z9RV14K95DvU.png
3379
+ */
3380
+ file_name?: string;
3381
+ /**
3382
+ * File Size
3383
+ * @description The size of the file in bytes.
3384
+ * @example 4404019
3385
+ */
3386
+ file_size?: number;
3387
+ /**
3388
+ * Sample Rate
3389
+ * @description The sample rate of the audio
3390
+ */
3391
+ sample_rate?: number;
3392
+ /**
3393
+ * Url
3394
+ * @description The URL where the file can be downloaded from.
3395
+ */
3396
+ url: string;
3397
+ }
3398
+
3402
3399
  export interface Audio {
3403
3400
  /**
3404
3401
  * Bitrate