-
Notifications
You must be signed in to change notification settings - Fork 4
/
openapi.json
1211 lines (1211 loc) · 38.5 KB
/
openapi.json
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"components": {
"schemas": {
"HTTPValidationError": {
"description": "HTTP validation error in API.",
"properties": {
"detail": {
"description": "Detail of the http validation error.",
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
},
"ImageEncoding": {
"description": "The image encoding types available for image generation response.",
"enum": [
"jpeg",
"png"
],
"title": "ImageEncoding",
"type": "string"
},
"ImageGeneration": {
"description": "Represent a generated image.",
"properties": {
"image_b64": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The generated image or None if it was removed for safety.",
"title": "Image in Base64"
},
"removed_for_safety": {
"description": "True if the image was removed for safety, False otherwise.",
"title": "Removed For Safety",
"type": "boolean"
},
"safety_score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Safety score of the image generated.",
"title": "Safety Score"
},
"seed": {
"description": "Seed used to generate the image. It can be used to recreate the generation.",
"title": "Seed",
"type": "integer"
}
},
"required": [
"image_b64",
"removed_for_safety",
"seed",
"safety_score"
],
"title": "ImageGeneration",
"type": "object"
},
"ImageGenerationRequest": {
"additionalProperties": false,
"description": "Generate one or more images based on the given parameters.",
"properties": {
"cfg_scale": {
"default": 12.0,
"description": "Floating-point number represeting how closely to adhere to prompt description. Must be a positive number no greater than 50.0.",
"examples": [
12.0
],
"exclusiveMinimum": 0.0,
"maximum": 50.0,
"title": "Classifier-free Guidance Scale",
"type": "number"
},
"checkpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] Custom checkpoint to be used during image generation.",
"examples": [
"dreamshaper"
],
"title": "Checkpoint"
},
"clip_skip": {
"anyOf": [
{
"maximum": 12.0,
"minimum": 1.0,
"type": "integer"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] Optionally skip later layers of the text encoder. Higher values lead to more abstract interpretations of the prompt.",
"examples": [
2
],
"title": "Clip Skip"
},
"controlnet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] ControlNet to be used during image generation.",
"examples": [
"canny"
],
"title": "ControlNet"
},
"controlnet_conditioning_scale": {
"default": 1.0,
"description": "[Not supported on SD3, FLUX] How strong the effect of the controlnet should be.",
"examples": [
1.0
],
"minimum": 0.0,
"title": "ControlNet Scale",
"type": "number"
},
"controlnet_early_stop": {
"anyOf": [
{
"maximum": 1.0,
"minimum": 0.0,
"type": "number"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] If provided, indicates fraction of steps at which to stop applying controlnet. This can be used to sometimes generate better outputs.",
"examples": [
0.5
],
"title": "ControlNet Early Stop"
},
"controlnet_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] Controlnet image encoded in b64 string for guiding image generation. Required for controlnet engines.",
"title": "ControlNet Image"
},
"controlnet_preprocess": {
"default": true,
"description": "[Not supported on SD3, FLUX] Whether to apply automatic ControlNet preprocessing.",
"examples": [
true
],
"title": "ControlNet Preprocessing",
"type": "boolean"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Integer representing the height of image to generate. None will default to 512 for SD 1.5 and 1024 for FLUX, SD3, SDXL, and SSD. Supported resolutions (w,h): FLUX=[(512, 512), (576, 1024), (640, 1536), (768, 1024), (768, 1344), (832, 1216), (896, 1152), (1024, 576), (1024, 768), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)], SD3=[(640, 1536), (768, 1344), (832, 1216), (896, 1152), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)], SDXL=[(640, 1536), (768, 1344), (832, 1216), (896, 1152), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)], SD1.5=[(384, 704), (448, 576), (512, 512), (512, 704), (512, 768), (512, 832), (576, 448), (576, 768), (576, 1024), (640, 512), (640, 640), (640, 768), (704, 384), (704, 1216), (768, 512), (768, 576), (768, 1024), (832, 512), (896, 896), (1024, 576), (1024, 768), (1024, 1024), (1024, 1536), (1216, 704), (1536, 1024)], SSD=[(640, 1536), (768, 1344), (832, 1216), (896, 1152), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)].",
"examples": [
1024
],
"title": "Output Image Height"
},
"high_noise_frac": {
"default": 0.8,
"description": "[Not supported on SD3, FLUX] Floating-point number that defines the fraction of steps to perform with the base model. Used only by SD XL. Must be greater than or equal to 0.0 and less than or equal to 1.0.",
"examples": [
0.8
],
"maximum": 1.0,
"minimum": 0.0,
"title": "High Noise Fraction",
"type": "number"
},
"image_encoding": {
"allOf": [
{
"$ref": "#/components/schemas/ImageEncoding"
}
],
"default": "jpeg",
"description": "Define which encoding process should be applied before returning the generated image(s).",
"examples": [
"jpeg"
],
"title": "Output Image Encoding"
},
"init_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Starting point image encoded in b64 string for Image to Image generation mode.",
"title": "Initial Image"
},
"inpaint_full_res": {
"default": false,
"description": "When true, upsample 'init_image' and 'mask_image' such that a bounding box drawn around the non-black content of 'mask_image' becomes the full inpainting frame. The bounding box has the same aspect ratio as that specified by ('height', 'width') parameters.",
"examples": [
false
],
"title": "Enable full-resolution inpainting",
"type": "boolean"
},
"inpaint_full_res_padding": {
"default": 32,
"description": "When 'inpaint_full_res' is true, include a frame around the non-black mask area that is this many pixels wide. This serves as a form of context for the inpainting and may improve blending.",
"examples": [
32
],
"title": "Full-resolution inpainting padding",
"type": "integer"
},
"log_prompt": {
"default": false,
"description": "OctoAI stores request prompt if True.",
"title": "Log Prompt",
"type": "boolean"
},
"loras": {
"anyOf": [
{
"additionalProperties": {
"type": "number"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3] A dictionary of LoRAs to apply. LoRAs as keys and their weights (float) as values.",
"examples": [
"{\"crayon-style\": 1.0}"
],
"title": "Dictionary of LoRAs"
},
"mask_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3] b64 encoded mask image for inpainting. White area should indicate where to paint.",
"title": "Mask Image"
},
"negative_prompt": {
"anyOf": [
{
"maxLength": 10000,
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not supported on FLUX] Text describing image traits to avoid during generation.",
"examples": [
"Fingers, distortions"
],
"title": "Negative Prompt"
},
"negative_prompt_2": {
"anyOf": [
{
"maxLength": 10000,
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] Text with a high level description of things to avoid during generation. Used only by SD XL.",
"examples": [
"Unusual proportions and distorted faces"
],
"title": "Second Negative Prompt"
},
"num_images": {
"default": 1,
"description": "Integer representing how many output images to generate with a single prompt/configuration.",
"examples": [
1
],
"exclusiveMinimum": 0.0,
"maximum": 16.0,
"title": "Number of Output Images",
"type": "integer"
},
"outpainting": {
"default": false,
"description": "[Not supported on SD3, FLUX] Whether the request requires outpainting or not. If so, special preprocessing is applied for better results.",
"examples": [
true
],
"title": "Outpainting",
"type": "boolean"
},
"prompt": {
"description": "Text describing the image content to generate.",
"examples": [
"An octopus playing chess, masterpiece, photorealistic"
],
"maxLength": 10000,
"title": "Input Prompt",
"type": "string"
},
"prompt_2": {
"anyOf": [
{
"maxLength": 10000,
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] Text with a high-level description of the image to generate. Used only by SD XL.",
"examples": [
"A painting of a cute cat wearing a hat"
],
"title": "Second Input Prompt"
},
"sampler": {
"allOf": [
{
"$ref": "#/components/schemas/Scheduler"
}
],
"default": "DDIM",
"description": "[Not supported on SD3, FLUX] Sampler name (also known as 'scheduler') to use during image generation.",
"examples": [
"DDIM"
],
"title": "Sampler Name"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Integer number or list of integers representing the seeds of random generators. Fixing random seed is useful when attempting to generate a specific image. Must be greater than 0 and less than 2^32.",
"examples": [
33445
],
"title": "Fixed Random Seed"
},
"steps": {
"default": 30,
"description": "Integer repreenting how many steps of diffusion to run. Must be greater than 0 and less than or equal to 200.",
"examples": [
30
],
"exclusiveMinimum": 0.0,
"maximum": 200.0,
"title": "Number of Steps",
"type": "integer"
},
"strength": {
"default": 0.8,
"description": "Floating-point number indicating how much creative the Image to Image generation mode should be. Must be greater than 0 and less than or equal to 1.0.",
"examples": [
0.8
],
"exclusiveMinimum": 0.0,
"maximum": 1.0,
"title": "Strength",
"type": "number"
},
"style_preset": {
"anyOf": [
{
"$ref": "#/components/schemas/SDXLStyles"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] Pre-defined styles used to guide the output image towards a particular style. Pre-defined styles are only supported by SDXL.",
"examples": [
"low-poly"
],
"title": "Pre-defined Styles"
},
"textual_inversions": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] A dictionary of textual inversions to be used during image generation. Textual inversions as keys and trigger words as values.",
"examples": [
"{\"name\": \"trigger_word\"}"
],
"title": "Dictionary of Textual Inversions"
},
"transfer_images": {
"anyOf": [
{
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "[Not supported on SD3, FLUX] A dictionary containing a mapping of trigger words to a list of sample images which demonstrate the desired object or style to transfer.",
"title": "Image Content Style Transfer Triggers and Samples."
},
"use_refiner": {
"default": true,
"description": "[Not supported on SD3, FLUX] Whether to enable and apply the SDXL refiner model to the image generation.",
"examples": [
true
],
"title": "Use Refiner",
"type": "boolean"
},
"vae": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "[Not Supported on SD3, FLUX] Custom VAE to be used during image generation.",
"examples": [
"my_vae"
],
"title": "VAE"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Integer representing the width of image to generate. None will default to 512 for SD 1.5 and 1024 for FLUX, SD3, SDXL, and SSD. Supported resolutions (w,h): FLUX=[(512, 512), (576, 1024), (640, 1536), (768, 1024), (768, 1344), (832, 1216), (896, 1152), (1024, 576), (1024, 768), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)], SD3=[(640, 1536), (768, 1344), (832, 1216), (896, 1152), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)], SDXL=[(640, 1536), (768, 1344), (832, 1216), (896, 1152), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)], SD1.5=[(384, 704), (448, 576), (512, 512), (512, 704), (512, 768), (512, 832), (576, 448), (576, 768), (576, 1024), (640, 512), (640, 640), (640, 768), (704, 384), (704, 1216), (768, 512), (768, 576), (768, 1024), (832, 512), (896, 896), (1024, 576), (1024, 768), (1024, 1024), (1024, 1536), (1216, 704), (1536, 1024)], SSD=[(640, 1536), (768, 1344), (832, 1216), (896, 1152), (1024, 1024), (1152, 896), (1216, 832), (1344, 768), (1536, 640)].",
"examples": [
1024
],
"title": "Output Image Width"
}
},
"required": [
"prompt"
],
"title": "ImageGenerationRequest",
"type": "object"
},
"ImageGenerationResponse": {
"description": "Response to an ImageGenerationRequest.",
"properties": {
"images": {
"description": "List of ImageGeneration(s) generated by the request.",
"items": {
"$ref": "#/components/schemas/ImageGeneration"
},
"title": "Images",
"type": "array"
},
"prediction_time_ms": {
"description": "Total runtime of the image generation(s).",
"title": "Prediction Time (ms)",
"type": "number"
}
},
"required": [
"images",
"prediction_time_ms"
],
"title": "ImageGenerationResponse",
"type": "object"
},
"SDXLStyles": {
"description": "The supported SDXL styles.",
"enum": [
"base",
"3d-model",
"analog-film",
"anime",
"cinematic",
"comic-book",
"Craft Clay",
"modeling-compound",
"digital-art",
"enhance",
"fantasy-art",
"isometric",
"line-art",
"low-poly",
"neon-punk",
"origami",
"photographic",
"pixel-art",
"tile-texture",
"Advertising",
"Food Photography",
"Real Estate",
"Abstract",
"Cubist",
"Graffiti",
"Hyperrealism",
"Impressionist",
"Pointillism",
"Pop Art",
"Psychedelic",
"Renaissance",
"Steampunk",
"Surrealist",
"Typography",
"Watercolor",
"Fighting Game",
"GTA",
"Super Mario",
"Minecraft",
"Pok\u00e9mon",
"Retro Arcade",
"Retro Game",
"RPG Fantasy Game",
"Strategy Game",
"Street Fighter",
"Legend of Zelda",
"Architectural",
"Disco",
"Dreamscape",
"Dystopian",
"Fairy Tale",
"Gothic",
"Grunge",
"Horror",
"Minimalist",
"Monochrome",
"Nautical",
"Space",
"Stained Glass",
"Techwear Fashion",
"Tribal",
"Zentangle",
"Collage",
"Flat Papercut",
"Kirigami",
"Paper Mache",
"Paper Quilling",
"Papercut Collage",
"Papercut Shadow Box",
"Stacked Papercut",
"Thick Layered Papercut",
"Alien",
"Film Noir",
"HDR",
"Long Exposure",
"Neon Noir",
"Silhouette",
"Tilt-Shift"
],
"title": "SDXLStyles",
"type": "string"
},
"Scheduler": {
"description": "The schedulers available for image generation.",
"enum": [
"PNDM",
"LMS",
"KLMS",
"DDIM",
"DDPM",
"HEUN",
"K_HEUN",
"K_EULER",
"K_EULER_ANCESTRAL",
"DPM_SOLVER_MULTISTEP",
"DPM_PLUS_PLUS_2M_KARRAS",
"DPM_PLUS_PLUS_2M_SDE",
"DPM_PLUS_PLUS_2M_SDE_KARRAS",
"DPM_SINGLE",
"DPM_2",
"DPM_2_KARRAS",
"DPM_2_ANCESTRAL",
"DPM_2_ANCESTRAL_KARRAS",
"DPM_PLUS_PLUS_SDE_KARRAS",
"UNI_PC",
"LCM"
],
"title": "Scheduler",
"type": "string"
},
"ValidationError": {
"description": "Validation error in API.",
"properties": {
"loc": {
"description": "Error location in ValidationError.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"description": "Error message in ValidationError.",
"title": "Message",
"type": "string"
},
"type": {
"description": "Error type in ValidationError.",
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"VideoGeneration": {
"description": "Represent a generated video/animation.",
"properties": {
"removed_for_safety": {
"description": "True if the video/animation was removed for safety, False otherwise.",
"title": "Removed For Safety",
"type": "boolean"
},
"safety_score": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Safety score of the video/animation generated.",
"title": "Safety Score"
},
"seed": {
"description": "Seed used to generate the video/animation. It can be used to recreate the generation.",
"title": "Seed",
"type": "integer"
},
"video": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The generated video/animation or None if it was removed for safety.",
"title": "Serialized Video/Animation"
}
},
"required": [
"video",
"removed_for_safety",
"seed",
"safety_score"
],
"title": "VideoGeneration",
"type": "object"
},
"VideoGenerationRequest": {
"additionalProperties": false,
"description": "Generate one video/animation based on the given parameters.",
"properties": {
"cfg_scale": {
"default": 3.0,
"description": "Floating-point number represeting how closely to adhere to 'image'. Must be a positive number no greater than 10.0.",
"examples": [
3.0
],
"exclusiveMinimum": 0.0,
"maximum": 10.0,
"title": "Classifier-free Guidance Scale",
"type": "number"
},
"constant_rate_factor": {
"default": 23,
"description": "Integer representing the quality of the video encoding. Higher quality means the file will be larger.The range of the CRF scale is [0,51], where 0 is lossless, 23 is the default, and 51 is worst quality possible.",
"examples": [
23
],
"maximum": 51.0,
"minimum": 0.0,
"title": "Constant Rate Factor",
"type": "integer"
},
"fps": {
"default": 7,
"description": "Integer representing how fast the generated frames should play back.",
"examples": [
7
],
"maximum": 25.0,
"minimum": 1.0,
"title": "Frames per Second",
"type": "integer"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Integer representing the height of video/animation to generate.If not provided, the output height will be inferred from the input 'image', and the closest resolution supported will be chosen. Supported resolutions (w,h): {(576, 1024), (1024, 576), (768, 768)}.",
"examples": [
576
],
"title": "Output Video/Animation Height"
},
"image": {
"description": "Starting point image encoded in base64 string.",
"title": "Initial Image",
"type": "string"
},
"motion_scale": {
"default": 0.5,
"description": "A floating point number between 0.0 and 1.0 indicating how much motion should be in the generated video/animation.",
"examples": [
0.5
],
"maximum": 1.0,
"minimum": 0.0,
"title": "Motion Scale",
"type": "number"
},
"noise_aug_strength": {
"default": 0.02,
"description": "A floating point number between 0.0 and 1.0 indicatiing how much noise to add to the initial image. Higher values encourage creativity.",
"examples": [
0.02
],
"maximum": 1.0,
"minimum": 0.0,
"title": "Noise Augmentation",
"type": "number"
},
"num_videos": {
"default": 1,
"description": "Integer representing how many output videos/animations to generate with a single 'image' and configuration.",
"examples": [
1
],
"exclusiveMinimum": 0.0,
"maximum": 16.0,
"title": "Number of Output Images",
"type": "integer"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"items": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Integer number or list of integers representing the seeds of random generators.Fixing random seed is useful when attempting to generate a specific video/animation (or set of videos/animations). Must be greater than 0 and less than 2^32.",
"examples": [
33445
],
"title": "Fixed Random Seed"
},
"steps": {
"default": 25,
"description": "Integer repreenting how many steps of diffusion to run. Must be greater than 0 and less than or equal to 50.",
"examples": [
25
],
"exclusiveMinimum": 0.0,
"maximum": 50.0,
"title": "Number of Steps",
"type": "integer"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Integer representing the width of video/animation to generate.If not provided, the output width will be inferred from the input 'image', and the closest resolution supported will be chosen. Supported resolutions (w,h): {(576, 1024), (1024, 576), (768, 768)}.",
"examples": [
1024
],
"title": "Output Video/Animation Width"
}
},
"required": [
"image"
],
"title": "VideoGenerationRequest",
"type": "object"
},
"VideoGenerationResponse": {
"description": "Response to an VideoGenerationRequest.",
"properties": {
"prediction_time_ms": {
"description": "Total runtime of the video(s) generation(s).",
"title": "Prediction Time (ms)",
"type": "number"
},
"videos": {
"description": "List of VideoGeneration(s) generated by the request.",
"items": {
"$ref": "#/components/schemas/VideoGeneration"
},
"title": "Videos",
"type": "array"
}
},
"required": [
"videos",
"prediction_time_ms"
],
"title": "VideoGenerationResponse",
"type": "object"
}
}
},
"info": {
"description": "Image Generation API.",
"title": "image-gen-api",
"version": "0.1"
},
"openapi": "3.1.0",
"paths": {
"/generate/controlnet-sdxl": {
"post": {
"description": "Generate images in response to the given request.",
"operationId": "generate_images_generate_controlnet_sdxl_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageGenerationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageGenerationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Generate Images"
}
},
"/generate/flux-dev": {
"post": {
"description": "Generate images in response to the given request.",
"operationId": "generate_images_generate_flux_dev_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageGenerationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageGenerationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"