-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathgateway.openapi.yaml
1246 lines (1246 loc) · 36.3 KB
/
gateway.openapi.yaml
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
# !!Auto-generated by 'gen_openapi.py'. DO NOT EDIT!!
openapi: 3.1.0
info:
title: Livepeer AI Runner
description: An application to run AI pipelines
version: 0.0.0
servers:
- url: https://dream-gateway.livepeer.cloud
description: Livepeer Cloud Community Gateway
- url: https://livepeer.studio/api/beta/generate
description: Livepeer Studio Gateway
paths:
/text-to-image:
post:
tags:
- generate
summary: Text To Image
description: Generate images from text prompts.
operationId: genTextToImage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TextToImageParams'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ImageResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: textToImage
/image-to-image:
post:
tags:
- generate
summary: Image To Image
description: Apply image transformations to a provided image.
operationId: genImageToImage
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_genImageToImage'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ImageResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: imageToImage
/image-to-video:
post:
tags:
- generate
summary: Image To Video
description: Generate a video from a provided image.
operationId: genImageToVideo
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_genImageToVideo'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VideoResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: imageToVideo
/upscale:
post:
tags:
- generate
summary: Upscale
description: Upscale an image by increasing its resolution.
operationId: genUpscale
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_genUpscale'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ImageResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: upscale
/audio-to-text:
post:
tags:
- generate
summary: Audio To Text
description: Transcribe audio files to text.
operationId: genAudioToText
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_genAudioToText'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TextResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'413':
description: Request Entity Too Large
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'415':
description: Unsupported Media Type
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: audioToText
/segment-anything-2:
post:
tags:
- generate
summary: Segment Anything 2
description: Segment objects in an image.
operationId: genSegmentAnything2
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_genSegmentAnything2'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MasksResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: segmentAnything2
/llm:
post:
tags:
- generate
summary: LLM
description: Generate text using a language model.
operationId: genLLM
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LLMRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LLMResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: llm
/image-to-text:
post:
tags:
- generate
summary: Image To Text
description: Transform image files to text.
operationId: genImageToText
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_genImageToText'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ImageToTextResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'413':
description: Request Entity Too Large
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: imageToText
/live-video-to-video:
post:
tags:
- generate
summary: Live Video To Video
description: Apply transformations to a live video streamed to the returned
endpoints.
operationId: genLiveVideoToVideo
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LiveVideoToVideoParams'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LiveVideoToVideoResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: liveVideoToVideo
/text-to-speech:
post:
tags:
- generate
summary: Text To Speech
description: Generate a text-to-speech audio file based on the provided text
input and speaker description.
operationId: genTextToSpeech
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TextToSpeechParams'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AudioResponse'
x-speakeasy-name-override: data
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPError'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
x-speakeasy-name-override: textToSpeech
components:
schemas:
APIError:
properties:
msg:
type: string
title: Msg
description: The error message.
type: object
required:
- msg
title: APIError
description: API error response model.
AudioResponse:
properties:
audio:
allOf:
- $ref: '#/components/schemas/MediaURL'
description: The generated audio.
type: object
required:
- audio
title: AudioResponse
description: Response model for audio generation.
Body_genAudioToText:
properties:
audio:
type: string
format: binary
title: Audio
description: Uploaded audio file to be transcribed.
model_id:
type: string
title: Model Id
description: Hugging Face model ID used for transcription.
default: ''
return_timestamps:
type: string
title: Return Timestamps
description: 'Return timestamps for the transcribed text. Supported values:
''sentence'', ''word'', or a string boolean (''true'' or ''false''). Default
is ''true'' (''sentence''). ''false'' means no timestamps. ''word'' means
word-based timestamps.'
default: 'true'
type: object
required:
- audio
- model_id
title: Body_genAudioToText
Body_genImageToImage:
properties:
prompt:
type: string
title: Prompt
description: Text prompt(s) to guide image generation.
image:
type: string
format: binary
title: Image
description: Uploaded image to modify with the pipeline.
model_id:
type: string
title: Model Id
description: Hugging Face model ID used for image generation.
default: ''
loras:
type: string
title: Loras
description: 'A LoRA (Low-Rank Adaptation) model and its corresponding weight
for image generation. Example: { "latent-consistency/lcm-lora-sdxl": 1.0,
"nerijs/pixel-art-xl": 1.2}.'
default: ''
strength:
type: number
title: Strength
description: Degree of transformation applied to the reference image (0
to 1).
default: 0.8
guidance_scale:
type: number
title: Guidance Scale
description: Encourages model to generate images closely linked to the text
prompt (higher values may reduce image quality).
default: 7.5
image_guidance_scale:
type: number
title: Image Guidance Scale
description: Degree to which the generated image is pushed towards the initial
image.
default: 1.5
negative_prompt:
type: string
title: Negative Prompt
description: Text prompt(s) to guide what to exclude from image generation.
Ignored if guidance_scale < 1.
default: ''
safety_check:
type: boolean
title: Safety Check
description: Perform a safety check to estimate if generated images could
be offensive or harmful.
default: true
seed:
type: integer
title: Seed
description: Seed for random number generation.
num_inference_steps:
type: integer
title: Num Inference Steps
description: Number of denoising steps. More steps usually lead to higher
quality images but slower inference. Modulated by strength.
default: 100
num_images_per_prompt:
type: integer
title: Num Images Per Prompt
description: Number of images to generate per prompt.
default: 1
type: object
required:
- prompt
- image
- model_id
title: Body_genImageToImage
Body_genImageToText:
properties:
image:
type: string
format: binary
title: Image
description: Uploaded image to transform with the pipeline.
prompt:
type: string
title: Prompt
description: Text prompt(s) to guide transformation.
default: ''
model_id:
type: string
title: Model Id
description: Hugging Face model ID used for transformation.
default: ''
type: object
required:
- image
- model_id
title: Body_genImageToText
Body_genImageToVideo:
properties:
image:
type: string
format: binary
title: Image
description: Uploaded image to generate a video from.
model_id:
type: string
title: Model Id
description: Hugging Face model ID used for video generation.
default: ''
height:
type: integer
title: Height
description: The height in pixels of the generated video.
default: 576
width:
type: integer
title: Width
description: The width in pixels of the generated video.
default: 1024
fps:
type: integer
title: Fps
description: The frames per second of the generated video.
default: 6
motion_bucket_id:
type: integer
title: Motion Bucket Id
description: Used for conditioning the amount of motion for the generation.
The higher the number the more motion will be in the video.
default: 127
noise_aug_strength:
type: number
title: Noise Aug Strength
description: Amount of noise added to the conditioning image. Higher values
reduce resemblance to the conditioning image and increase motion.
default: 0.02
safety_check:
type: boolean
title: Safety Check
description: Perform a safety check to estimate if generated images could
be offensive or harmful.
default: true
seed:
type: integer
title: Seed
description: Seed for random number generation.
num_inference_steps:
type: integer
title: Num Inference Steps
description: Number of denoising steps. More steps usually lead to higher
quality images but slower inference. Modulated by strength.
default: 25
type: object
required:
- image
- model_id
title: Body_genImageToVideo
Body_genSegmentAnything2:
properties:
image:
type: string
format: binary
title: Image
description: Image to segment.
model_id:
type: string
title: Model Id
description: Hugging Face model ID used for image generation.
default: ''
point_coords:
type: string
title: Point Coords
description: Nx2 array of point prompts to the model, where each point is
in (X,Y) in pixels.
point_labels:
type: string
title: Point Labels
description: Labels for the point prompts, where 1 indicates a foreground
point and 0 indicates a background point.
box:
type: string
title: Box
description: A length 4 array given as a box prompt to the model, in XYXY
format.
mask_input:
type: string
title: Mask Input
description: A low-resolution mask input to the model, typically from a
previous prediction iteration, with the form 1xHxW (H=W=256 for SAM).
multimask_output:
type: boolean
title: Multimask Output
description: If true, the model will return three masks for ambiguous input
prompts, often producing better masks than a single prediction.
default: true
return_logits:
type: boolean
title: Return Logits
description: If true, returns un-thresholded mask logits instead of a binary
mask.
default: true
normalize_coords:
type: boolean
title: Normalize Coords
description: If true, the point coordinates will be normalized to the range
[0,1], with point_coords expected to be with respect to image dimensions.
default: true
type: object
required:
- image
- model_id
title: Body_genSegmentAnything2
Body_genUpscale:
properties:
prompt:
type: string
title: Prompt
description: Text prompt(s) to guide upscaled image generation.
image:
type: string
format: binary
title: Image
description: Uploaded image to modify with the pipeline.
model_id:
type: string
title: Model Id
description: Hugging Face model ID used for upscaled image generation.
default: ''
safety_check:
type: boolean
title: Safety Check
description: Perform a safety check to estimate if generated images could
be offensive or harmful.
default: true
seed:
type: integer
title: Seed
description: Seed for random number generation.
num_inference_steps:
type: integer
title: Num Inference Steps
description: Number of denoising steps. More steps usually lead to higher
quality images but slower inference. Modulated by strength.
default: 75
type: object
required:
- prompt
- image
- model_id
title: Body_genUpscale
Chunk:
properties:
timestamp:
items: {}
type: array
title: Timestamp
description: The timestamp of the chunk.
text:
type: string
title: Text
description: The text of the chunk.
type: object
required:
- timestamp
- text
title: Chunk
description: A chunk of text with a timestamp.
HTTPError:
properties:
detail:
allOf:
- $ref: '#/components/schemas/APIError'
description: Detailed error information.
type: object
required:
- detail
title: HTTPError
description: HTTP error response model.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ImageResponse:
properties:
images:
items:
$ref: '#/components/schemas/Media'
type: array
title: Images
description: The generated images.
type: object
required:
- images
title: ImageResponse
description: Response model for image generation.
ImageToTextResponse:
properties:
text:
type: string
title: Text
description: The generated text.
type: object
required:
- text
title: ImageToTextResponse
description: Response model for text generation.
LLMChoice:
properties:
index:
type: integer
title: Index
finish_reason:
type: string
title: Finish Reason
default: ''
delta:
allOf:
- $ref: '#/components/schemas/LLMMessage'
message:
allOf:
- $ref: '#/components/schemas/LLMMessage'
type: object
required:
- index
title: LLMChoice
LLMMessage:
properties:
role:
type: string
title: Role
content:
type: string
title: Content
type: object
required:
- role
- content
title: LLMMessage
LLMRequest:
properties:
messages:
items:
$ref: '#/components/schemas/LLMMessage'
type: array
title: Messages
model:
type: string
title: Model
default: ''
temperature:
type: number
title: Temperature
default: 0.7
max_tokens:
type: integer
title: Max Tokens
default: 256
top_p:
type: number
title: Top P
default: 1.0
top_k:
type: integer
title: Top K
default: -1
stream:
type: boolean
title: Stream
default: false
type: object
required:
- messages
title: LLMRequest
LLMResponse:
properties:
id:
type: string
title: Id
model:
type: string
title: Model
created:
type: integer
title: Created
usage:
$ref: '#/components/schemas/LLMTokenUsage'
choices:
items:
$ref: '#/components/schemas/LLMChoice'
type: array
title: Choices
type: object
required:
- id
- model
- created
- usage
- choices
title: LLMResponse
LLMTokenUsage:
properties:
prompt_tokens:
type: integer
title: Prompt Tokens
completion_tokens:
type: integer
title: Completion Tokens
total_tokens:
type: integer
title: Total Tokens
type: object
required:
- prompt_tokens
- completion_tokens
- total_tokens
title: LLMTokenUsage
LiveVideoToVideoParams:
properties:
subscribe_url:
type: string
title: Subscribe Url
description: Source URL of the incoming stream to subscribe to.
publish_url:
type: string
title: Publish Url
description: Destination URL of the outgoing stream to publish.
control_url:
type: string
title: Control Url
description: URL for subscribing via Trickle protocol for updates in the
live video-to-video generation params.
default: ''
events_url:
type: string
title: Events Url
description: URL for publishing events via Trickle protocol for pipeline