-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1174 lines (1174 loc) · 35.1 KB
/
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
openapi: 3.0.0
info:
title: Synchronize API
description: Synchronize API allows you to lipsync a video to any audio in any language.
version: '1.0'
contact: {}
servers:
- url: https://api.synclabs.so
tags:
- name: voices
- name: video
- name: lipsync
- name: translate
- name: speak
- name: animate
paths:
/video/cost:
get:
tags:
- video
summary: ''
operationId: VideoController_cost
parameters:
- description: >-
A url to the audio file to be synchronized -- must be publicly
accessible
name: audioUrl
required: true
in: query
schema:
type: string
- description: >-
A url to the video file to be synchronized -- must be publicly
accessible
name: videoUrl
required: true
in: query
schema:
type: string
responses:
'200':
description: ''
deprecated: true
/video:
post:
tags:
- video
summary: ''
operationId: VideoController_lipSync
description: >-
[Deprecated] Submit a set of urls to publically hosted audio and video
files or to YouTube videos. Our synchronizer will sync the video's lip
movements to match the audio and return the synced video.
parameters: []
requestBody:
description: >-
The audio + video data to be synced. Set synergize = false to skip our
synergizer post-processor for a 10x speedup, but w/ a degredation in
output quality.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVideoDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/VideoInitial'
deprecated: true
/video/{id}:
get:
tags:
- video
summary: ''
operationId: VideoController_getLipSyncJob
description: >-
[Deprecated] Use the video ID from the POST request to check video
status. Keep checking until status is 'completed' and a download URL is
provided.
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: Returns video status and URL to download from.
content:
application/json:
schema:
$ref: '#/components/schemas/VideoExtended'
deprecated: true
/voices/cost:
get:
tags:
- voices
operationId: VoicesController_voiceCost
parameters: []
responses:
'200':
description: ''
/voices:
get:
tags:
- voices
summary: ''
operationId: VoicesController_voices
description: Get all voices
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/VoicesControllerVoicesResponse'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/voices/create:
post:
tags:
- voices
summary: ''
operationId: VoicesController_createVoice
description: >-
Generates audio given inputted text and voice and synchronizes with the
given video.
parameters: []
requestBody:
description: >-
Required data for animating video. Includes video URL, transcript,
voice, and optional parameters for webhook integration and credit
limits.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVoiceDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Voice'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/voices/{id}:
get:
tags:
- voices
summary: ''
operationId: VoicesController_getVoice
description: >-
Use the ID from the POST request to check status. Keep checking until
status is 'completed' and a download URL is provided.
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: Returns status and URL to download from.
content:
application/json:
schema:
$ref: '#/components/schemas/Voice'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/lipsync/cost:
get:
tags:
- lipsync
summary: ''
operationId: LipSyncController_lipsyncCost
description: >-
Get the cost of a lipsync job. The cost is based on the frame rate of
the video, length of the audio and model used. The cost is returned in
credits.
parameters:
- description: >-
A url to the audio file to be synchronized -- must be publicly
accessible
name: audioUrl
required: true
in: query
schema:
type: string
- description: >-
A url to the video file to be synchronized -- must be publicly
accessible
name: videoUrl
required: true
in: query
schema:
type: string
responses:
'200':
description: Returns the cost of the lipsync job.
content:
application/json:
schema:
$ref: '#/components/schemas/LipsyncCost'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/lipsync:
post:
tags:
- lipsync
summary: ''
operationId: LipSyncController_lipSync
description: >-
Submit a set of urls to publically hosted audio and video files or to
YouTube videos. Our synchronizer will sync the video's lip movements to
match the audio and return the synced video.
parameters: []
requestBody:
description: >-
The audio + video data to be synced. Set synergize = false to skip our
synergizer post-processor for a 10x speedup, but w/ a degredation in
output quality.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LipsyncDto'
responses:
'201':
description: Lipsync job created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Lipsync'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/lipsync/{id}:
get:
tags:
- lipsync
summary: ''
operationId: LipSyncController_getLipsync
description: >-
Use the video ID from the POST request to check video status. Keep
checking until status is 'completed' and a download URL is provided.
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: Returns video status and URL to download from.
content:
application/json:
schema:
$ref: '#/components/schemas/Lipsync'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/translate/cost:
get:
tags:
- translate
summary: ''
operationId: TranslateController_translationCost
description: >-
Get the cost of a lipsync job. The cost is based on the frame rate of
the video, length of the audio and model used. The cost is returned in
credits.
parameters:
- description: >-
A url to the video file to be synchronized -- must be publicly
accessible
name: videoUrl
required: true
in: query
schema:
type: string
responses:
'200':
description: Returns the cost of the lipsync job.
content:
application/json:
schema:
$ref: '#/components/schemas/TranslationCost'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/translate:
post:
tags:
- translate
summary: ''
operationId: TranslateController_translate
description: >-
Translates and synchronizes the given video to the specified target
language.
parameters: []
requestBody:
description: >-
Required data for translating and synchronizing video. Includes video
URL, target language, and optional parameters for model selection,
webhook integration, and credit limits.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TranslateDto'
responses:
'201':
description: The translation job has been successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/Translate'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/translate/{id}:
get:
tags:
- translate
summary: ''
operationId: TranslateController_getTranslation
description: >-
Use the video ID from the POST request to check video status. Keep
checking until status is 'completed' and a download URL is provided.
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: Returns video status and URL to download from.
content:
application/json:
schema:
$ref: '#/components/schemas/Translate'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/speak/cost:
get:
tags:
- speak
summary: ''
operationId: SpeakController_speakCost
description: >-
Get the cost of a speech synthesis job. The cost is based on the number
of characters of text to synthesize. The cost is returned in credits.
parameters:
- description: A string of text to be spoken by the AI
name: transcript
required: false
in: query
schema:
type: string
- description: A url pointing to a file of text to be spoken by the AI
name: transcriptUrl
required: false
in: query
schema:
type: string
responses:
'200':
description: Returns the cost of the speech synthesis job.
content:
application/json:
schema:
$ref: '#/components/schemas/SpeakCost'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/speak:
post:
tags:
- speak
summary: ''
operationId: SpeakController_speak
description: ''
parameters: []
requestBody:
description: ''
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpeakDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Speak'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/speak/{id}:
get:
tags:
- speak
summary: ''
operationId: SpeakController_getSpeech
description: >-
Use the video ID from the POST request to check video status. Keep
checking until status is 'completed' and a download URL is provided.
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: Returns video status and URL to download from.
content:
application/json:
schema:
$ref: '#/components/schemas/Speak'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/animate/cost:
get:
tags:
- animate
summary: ''
operationId: AnimateController_animateCost
description: >-
Get the cost of an animate job. The cost is based on the frame rate of
the video, and the number of characters of text to animate. The cost is
returned in credits.
parameters:
- description: A string of text to be spoken by the AI
name: transcript
required: false
in: query
schema:
type: string
- description: A url pointing to a file of text to be spoken by the AI
name: transcriptUrl
required: false
in: query
schema:
type: string
responses:
'200':
description: Returns the cost of the animate job.
content:
application/json:
schema:
$ref: '#/components/schemas/AnimateCost'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/animate:
post:
tags:
- animate
summary: ''
operationId: AnimateController_animate
description: >-
Generates audio given inputted text and voice and synchronizes with the
given video.
parameters: []
requestBody:
description: >-
Required data for animating video. Includes video URL, transcript,
voice, and optional parameters for webhook integration and credit
limits.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnimateDto'
responses:
'201':
description: Animation job created. Check status with GET request.
content:
application/json:
schema:
$ref: '#/components/schemas/Animate'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/animate/{id}:
get:
tags:
- animate
summary: ''
operationId: AnimateController_getAnimation
description: >-
Use the ID from the POST request to check status. Keep checking until
status is 'completed' and a download URL is provided.
parameters:
- name: id
required: true
in: path
schema:
type: string
responses:
'200':
description: Returns status and URL to download from.
content:
application/json:
schema:
$ref: '#/components/schemas/Animate'
'403':
description: Forbidden resource. Check your API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
schemas:
CreateVideoDto:
type: object
properties:
audioUrl:
description: >-
A url to the audio file to be synchronized -- must be publicly
accessible
type: string
videoUrl:
description: >-
A url to the video file to be synchronized -- must be publicly
accessible
type: string
synergize:
description: A flag to enable / disable post-processing
type: boolean
default: true
maxCredits:
description: >-
Maximum number of credits to use for video generation. If job
exceeds this value, the job will be aborted
type: number
default: null
webhookUrl:
description: A url to send a notification to upon completion of video generation
type: string
default: null
model:
description: The model to use for video generation
type: string
default: sync-1.6.0
required:
- audioUrl
- videoUrl
- synergize
VideoInitial:
type: object
properties:
id:
description: A unique identifier for the video.
type: string
url:
description: A URL which can be used to download the video.
type: string
original_video_url:
description: The original URL of the video that was submitted.
type: string
original_audio_url:
description: The original URL of the audio that was submitted.
type: string
status:
description: The status of the video.
type: string
synergize:
description: A flag to enable / disable post-processing
type: boolean
required:
- id
- original_video_url
- original_audio_url
- status
- synergize
VideoExtended:
type: object
properties:
id:
description: A unique identifier for the video.
type: string
url:
description: A URL which can be used to download the video.
type: string
original_video_url:
description: The original URL of the video that was submitted.
type: string
original_audio_url:
description: The original URL of the audio that was submitted.
type: string
status:
description: The status of the video.
type: string
synergize:
description: A flag to enable / disable post-processing
type: boolean
credits_deducted:
description: The number of credits deducted for the video.
type: number
required:
- id
- original_video_url
- original_audio_url
- status
- synergize
- credits_deducted
VoiceDetails:
type: object
properties:
description:
description: A description the voice.
type: object
id:
description: A unique identifier for the voice.
type: string
status:
description: The status of the voice.
type: object
name:
description: A name for the voice.
type: object
inputSamples:
description: Input samples for creating the voice.
type: array
items:
type: string
outputSamples:
description: Output samples for hearing the voice.
type: array
items:
type: string
required:
- id
- status
- inputSamples
- outputSamples
ApiError:
type: object
properties:
statusCode:
description: The status code of the error.
type: number
message:
description: The error message.
type: string
error:
description: The error.
type: string
required:
- statusCode
- message
- error
CreateVoiceDto:
type: object
properties:
description:
description: >-
The description of the voice. Helpful for keeping track of voice
details.
type: string
example: This is a test voice. It's used for testing purposes.
name:
description: The name of the voice. Helpful for organization and search purposes.
type: string
example: Test voice
inputSamples:
description: A list of audio samples to use for voice generation
type: array
items:
type: string
maxCredits:
description: >-
Maximum number of credits to use for audio generation. If job
exceeds this value, the job will be aborted
type: number
default: null
webhookUrl:
description: A url to send a notification to upon completion of audio generation
type: string
default: null
required:
- inputSamples
Voice:
type: object
properties:
description:
description: A description the voice.
type: object
id:
description: A unique identifier for the voice.
type: string
status:
description: The status of the voice.
type: object
name:
description: A name for the voice.
type: object
inputSamples:
description: Input samples for creating the voice.
type: array
items:
type: string
outputSamples:
description: Output samples for hearing the voice.
type: array
items:
type: string
creditsDeducted:
description: The cost of the voice.
type: object
webhookUrl:
description: The webhook URL for the voice.
type: object
required:
- id
- status
- inputSamples
- outputSamples
- creditsDeducted
- webhookUrl
LipsyncCost:
type: object
properties:
credits:
description: The cost of the lipsync job.
type: number
videoLength:
description: The length of the synchronized video in seconds.
type: number
required:
- credits
- videoLength
LipsyncDto:
type: object
properties:
audioUrl:
description: >-
A url to the audio file to be synchronized -- must be publicly
accessible
type: string
example: >-
https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortaud-27623a4f-edab-4c6a-8383-871b18961a4a.wav
videoUrl:
description: >-
A url to the video file to be synchronized -- must be publicly
accessible
type: string
example: >-
https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4
maxCredits:
description: >-
Maximum number of credits to use for video generation. If job
exceeds this value, the job will be aborted
type: number
default: null
model:
description: The model to use for video generation
type: string
default: sync-1.6.0
example: sync-1.6.0
synergize:
description: enable, disable restoration stage | highly recommended to keep on
type: boolean
default: true
example: true
pads:
description: '[top, bottom, left, right], number of pixels to add as padding'
example:
- 0
- 5
- 0
- 0
type: array
items:
type: string
synergizerStrength:
description: >-
1 is very good quality but identity features will reduce, 0 is very
natural / identity will be preserved but less clean up of artifacts
type: number
example: 1
webhookUrl:
description: A url to send a notification to upon completion of video generation
type: string
default: null
required:
- audioUrl
- videoUrl
Lipsync:
type: object
properties:
id:
description: A unique identifier for the video.
type: string
status:
description: The status of the video.
type: string
videoUrl:
description: A URL which can be used to download the video.
type: object
originalVideoUrl:
description: The original URL of the video that was submitted.
type: string
originalAudioUrl:
description: The original URL of the audio that was submitted.
type: string
synergize:
description: A flag to enable / disable post-processing
type: boolean
creditsDeducted:
description: The number of credits deducted for the video.
type: object
webhookUrl:
description: The URL to the webhook endpoint.
type: object
url:
description: >-
DEPRECATED - now use `videoUrl` - A URL which can be used to
download the video.
type: object
original_video_url:
description: >-
DEPRECATED - now use `originalVideoUrl` - The original URL of the
video that was submitted.
type: string
original_audio_url:
description: >-
DEPRECATED - now use `originalAudioUrl` - The original URL of the
audio that was submitted.
type: string
credits_deducted:
description: >-
DEPRECATED - now use `creditsDeducted` - The number of credits
deducted for the video.
type: object
message:
description: An important message related to the API response.
type: string
required:
- id
- status
- videoUrl
- originalVideoUrl
- originalAudioUrl
- synergize
- creditsDeducted
- webhookUrl
- url
- original_video_url
- original_audio_url
- credits_deducted
- message
TranslationCost:
type: object
properties:
credits:
description: The cost of the translation job.
type: number
videoLength:
description: The length of the translated and synchronized video in seconds.
type: number
required:
- credits
- videoLength
TranslateDto:
type: object
properties:
videoUrl:
description: >-
A url to the video file to be translated and synchronized -- must be
publicly accessible
type: string
example: >-
https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4
targetLanguage:
description: Target language to translate the video to
type: string
default: en
example: en
maxCredits:
description: >-
Maximum number of credits to use for video generation. If job
exceeds this value, the job will be aborted
type: number
default: null
webhookUrl:
description: A url to send a notification to upon completion of video generation
type: string
default: null
model:
description: The model to use for video generation.
type: string
default: sync-1.6.0
example: sync-1.6.0
required:
- videoUrl
- targetLanguage
Translate:
type: object
properties:
id:
description: A unique identifier for the translation job.
type: string
status:
description: The status of the translation job.
type: string
step:
description: The step of the translation job.
type: object
videoUrl:
description: A URL which can be used to download the video.
type: object
audioUrl:
description: A URL which can be used to download the audio.
type: object
transcriptUrl:
description: A URL to access the transcript of the video.
type: object
originalVideoUrl:
description: The original URL of the video that was submitted.
type: string
sourceLanguage:
description: The source language of the video.
type: object
targetLanguage:
description: The language into which the video is being translated.
type: string
creditsDeducted:
description: The number of credits deducted for the translation.
type: object
webhookUrl:
description: The webhook URL for the translation job.
type: object
required:
- id
- status