-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2279 lines (2192 loc) · 54.1 KB
/
openapi.yaml
File metadata and controls
2279 lines (2192 loc) · 54.1 KB
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.1.0
info:
title: WAVE Enterprise Streaming Platform API
description: |
Complete API reference for WAVE Enterprise Streaming Platform.
## Authentication
All API requests require a Bearer token in the Authorization header:
```
Authorization: Bearer YOUR_API_KEY
```
## Rate Limiting
API requests are rate limited. When rate limited, you'll receive a 429 response
with a `Retry-After` header indicating when to retry.
## Pagination
List endpoints support pagination via `page` and `perPage` query parameters.
Responses include pagination metadata.
## Errors
All errors return a JSON body with `message` and optional `errors` array.
version: 1.0.0
contact:
name: WAVE Developer Support
url: https://wave.online/developers
email: developers@wave.online
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: https://api.wave.online/v1
description: Production API
- url: https://api.staging.wave.online/v1
description: Staging API
security:
- BearerAuth: []
tags:
- name: Clips
description: AI-powered highlight detection and clip management
- name: Voice
description: Text-to-speech synthesis and voice cloning
- name: Captions
description: Auto-captioning and multi-language translation
- name: Chapters
description: AI chapter detection and video segmentation
- name: Editor
description: Cloud video editing projects
- name: Phone
description: VoIP phone lines and call management
- name: Collab
description: Real-time collaboration rooms
- name: Podcast
description: Podcast show and episode management
- name: Studio AI
description: Video enhancement and AI processing
- name: Transcribe
description: Speech-to-text transcription
- name: Sentiment
description: Sentiment and emotion analysis
- name: Search
description: Semantic content search
paths:
# Clips API
/clips:
get:
tags: [Clips]
summary: List clips
operationId: listClips
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: videoId
in: query
schema:
type: string
- name: status
in: query
schema:
$ref: '#/components/schemas/JobStatus'
- name: category
in: query
schema:
type: string
responses:
'200':
description: Paginated list of clips
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Clip'
post:
tags: [Clips]
summary: Create a clip
operationId: createClip
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClipCreate'
responses:
'201':
description: Clip created
content:
application/json:
schema:
$ref: '#/components/schemas/Clip'
'400':
$ref: '#/components/responses/ValidationError'
/clips/{clipId}:
get:
tags: [Clips]
summary: Get a clip
operationId: getClip
parameters:
- name: clipId
in: path
required: true
schema:
type: string
responses:
'200':
description: Clip details
content:
application/json:
schema:
$ref: '#/components/schemas/Clip'
'404':
$ref: '#/components/responses/NotFoundError'
patch:
tags: [Clips]
summary: Update a clip
operationId: updateClip
parameters:
- name: clipId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClipUpdate'
responses:
'200':
description: Clip updated
content:
application/json:
schema:
$ref: '#/components/schemas/Clip'
delete:
tags: [Clips]
summary: Delete a clip
operationId: deleteClip
parameters:
- name: clipId
in: path
required: true
schema:
type: string
responses:
'204':
description: Clip deleted
/clips/detect:
post:
tags: [Clips]
summary: Start AI clip detection
operationId: detectClips
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClipDetectRequest'
responses:
'202':
description: Detection job started
content:
application/json:
schema:
$ref: '#/components/schemas/DetectionJob'
# Voice API
/voice/voices:
get:
tags: [Voice]
summary: List available voices
operationId: listVoices
parameters:
- name: category
in: query
schema:
type: string
enum: [premade, cloned, professional]
- name: language
in: query
schema:
type: string
responses:
'200':
description: List of voices
content:
application/json:
schema:
type: object
properties:
voices:
type: array
items:
$ref: '#/components/schemas/Voice'
/voice/generate:
post:
tags: [Voice]
summary: Generate speech from text
operationId: generateSpeech
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceGenerateRequest'
responses:
'200':
description: Voice generation created
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceGeneration'
/voice/clone:
post:
tags: [Voice]
summary: Clone a voice from audio samples
operationId: cloneVoice
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceCloneRequest'
responses:
'201':
description: Voice cloned
content:
application/json:
schema:
$ref: '#/components/schemas/Voice'
# Captions API
/captions:
get:
tags: [Captions]
summary: List caption jobs
operationId: listCaptions
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: videoId
in: query
schema:
type: string
- name: status
in: query
schema:
$ref: '#/components/schemas/JobStatus'
responses:
'200':
description: Paginated list of caption jobs
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CaptionJob'
post:
tags: [Captions]
summary: Create a caption job
operationId: createCaptionJob
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CaptionJobCreate'
responses:
'201':
description: Caption job created
content:
application/json:
schema:
$ref: '#/components/schemas/CaptionJob'
/captions/{jobId}:
get:
tags: [Captions]
summary: Get a caption job
operationId: getCaptionJob
parameters:
- name: jobId
in: path
required: true
schema:
type: string
responses:
'200':
description: Caption job details
content:
application/json:
schema:
$ref: '#/components/schemas/CaptionJob'
delete:
tags: [Captions]
summary: Delete a caption job
operationId: deleteCaptionJob
parameters:
- name: jobId
in: path
required: true
schema:
type: string
responses:
'204':
description: Caption job deleted
/captions/{jobId}/download:
get:
tags: [Captions]
summary: Download captions
operationId: downloadCaptions
parameters:
- name: jobId
in: path
required: true
schema:
type: string
- name: language
in: query
required: true
schema:
type: string
- name: format
in: query
schema:
type: string
enum: [srt, vtt, txt, json]
default: srt
responses:
'200':
description: Caption download
content:
application/json:
schema:
type: object
properties:
url:
type: string
format: uri
content:
type: string
# Chapters API
/videos/{videoId}/chapters:
get:
tags: [Chapters]
summary: List chapters for a video
operationId: listChapters
parameters:
- name: videoId
in: path
required: true
schema:
type: string
responses:
'200':
description: List of chapters
content:
application/json:
schema:
type: object
properties:
chapters:
type: array
items:
$ref: '#/components/schemas/Chapter'
post:
tags: [Chapters]
summary: Create a chapter
operationId: createChapter
parameters:
- name: videoId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChapterCreate'
responses:
'201':
description: Chapter created
content:
application/json:
schema:
$ref: '#/components/schemas/Chapter'
/videos/{videoId}/chapters/detect:
post:
tags: [Chapters]
summary: Start AI chapter detection
operationId: detectChapters
parameters:
- name: videoId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChapterDetectRequest'
responses:
'202':
description: Detection job started
content:
application/json:
schema:
$ref: '#/components/schemas/DetectionJob'
# Editor API
/editor/projects:
get:
tags: [Editor]
summary: List editor projects
operationId: listProjects
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: status
in: query
schema:
type: string
responses:
'200':
description: Paginated list of projects
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/EditorProject'
post:
tags: [Editor]
summary: Create an editor project
operationId: createProject
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EditorProjectCreate'
responses:
'201':
description: Project created
content:
application/json:
schema:
$ref: '#/components/schemas/EditorProject'
/editor/projects/{projectId}:
get:
tags: [Editor]
summary: Get a project
operationId: getProject
parameters:
- name: projectId
in: path
required: true
schema:
type: string
responses:
'200':
description: Project details
content:
application/json:
schema:
$ref: '#/components/schemas/EditorProject'
patch:
tags: [Editor]
summary: Update a project
operationId: updateProject
parameters:
- name: projectId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditorProjectUpdate'
responses:
'200':
description: Project updated
content:
application/json:
schema:
$ref: '#/components/schemas/EditorProject'
delete:
tags: [Editor]
summary: Delete a project
operationId: deleteProject
parameters:
- name: projectId
in: path
required: true
schema:
type: string
responses:
'204':
description: Project deleted
/editor/projects/{projectId}/export:
post:
tags: [Editor]
summary: Export a project
operationId: exportProject
parameters:
- name: projectId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportRequest'
responses:
'202':
description: Export started
content:
application/json:
schema:
$ref: '#/components/schemas/ExportJob'
# Phone API
/phone/lines:
get:
tags: [Phone]
summary: List phone lines
operationId: listPhoneLines
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Paginated list of phone lines
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PhoneLine'
post:
tags: [Phone]
summary: Provision a phone line
operationId: provisionPhoneLine
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneLineProvision'
responses:
'201':
description: Phone line provisioned
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneLine'
/phone/calls:
get:
tags: [Phone]
summary: List calls
operationId: listCalls
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: lineId
in: query
schema:
type: string
- name: direction
in: query
schema:
type: string
enum: [inbound, outbound]
responses:
'200':
description: Paginated list of calls
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Call'
post:
tags: [Phone]
summary: Make a call
operationId: makeCall
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CallCreate'
responses:
'201':
description: Call initiated
content:
application/json:
schema:
$ref: '#/components/schemas/Call'
# Collab API
/collab/rooms:
get:
tags: [Collab]
summary: List collaboration rooms
operationId: listCollabRooms
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: status
in: query
schema:
type: string
enum: [waiting, active, ended]
responses:
'200':
description: Paginated list of rooms
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CollabRoom'
post:
tags: [Collab]
summary: Create a collaboration room
operationId: createCollabRoom
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CollabRoomCreate'
responses:
'201':
description: Room created
content:
application/json:
schema:
$ref: '#/components/schemas/CollabRoom'
/collab/rooms/{roomId}:
get:
tags: [Collab]
summary: Get a room
operationId: getCollabRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
responses:
'200':
description: Room details
content:
application/json:
schema:
$ref: '#/components/schemas/CollabRoom'
delete:
tags: [Collab]
summary: Delete a room
operationId: deleteCollabRoom
parameters:
- name: roomId
in: path
required: true
schema:
type: string
responses:
'204':
description: Room deleted
# Podcast API
/podcast/shows:
get:
tags: [Podcast]
summary: List podcast shows
operationId: listPodcastShows
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Paginated list of shows
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PodcastShow'
post:
tags: [Podcast]
summary: Create a podcast show
operationId: createPodcastShow
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PodcastShowCreate'
responses:
'201':
description: Show created
content:
application/json:
schema:
$ref: '#/components/schemas/PodcastShow'
/podcast/shows/{showId}/episodes:
get:
tags: [Podcast]
summary: List episodes for a show
operationId: listPodcastEpisodes
parameters:
- name: showId
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
description: Paginated list of episodes
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PodcastEpisode'
post:
tags: [Podcast]
summary: Create an episode
operationId: createPodcastEpisode
parameters:
- name: showId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PodcastEpisodeCreate'
responses:
'201':
description: Episode created
content:
application/json:
schema:
$ref: '#/components/schemas/PodcastEpisode'
# Studio AI API
/studio-ai/enhancements:
get:
tags: [Studio AI]
summary: List enhancement jobs
operationId: listEnhancements
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: type
in: query
schema:
type: string
enum: [upscale, denoise, stabilize, color_correct, super_resolution]
- name: status
in: query
schema:
$ref: '#/components/schemas/JobStatus'
responses:
'200':
description: Paginated list of enhancements
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Enhancement'
post:
tags: [Studio AI]
summary: Create an enhancement job
operationId: createEnhancement
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EnhancementCreate'
responses:
'201':
description: Enhancement created
content:
application/json:
schema:
$ref: '#/components/schemas/Enhancement'
/studio-ai/preview:
post:
tags: [Studio AI]
summary: Generate enhancement preview
operationId: previewEnhancement
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EnhancementPreviewRequest'
responses:
'200':
description: Preview generated
content:
application/json:
schema:
type: object
properties:
beforeUrl:
type: string
format: uri
afterUrl:
type: string
format: uri
# Transcribe API
/transcribe:
get:
tags: [Transcribe]
summary: List transcriptions
operationId: listTranscriptions
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: status
in: query
schema:
$ref: '#/components/schemas/JobStatus'
responses:
'200':
description: Paginated list of transcriptions
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Transcription'
post:
tags: [Transcribe]
summary: Create a transcription
operationId: createTranscription
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TranscriptionCreate'
responses:
'201':
description: Transcription created
content:
application/json:
schema:
$ref: '#/components/schemas/Transcription'
/transcribe/{transcriptionId}:
get:
tags: [Transcribe]
summary: Get a transcription
operationId: getTranscription
parameters:
- name: transcriptionId
in: path
required: true
schema:
type: string
responses:
'200':
description: Transcription details
content:
application/json:
schema:
$ref: '#/components/schemas/Transcription'
delete:
tags: [Transcribe]
summary: Delete a transcription
operationId: deleteTranscription
parameters:
- name: transcriptionId
in: path
required: true
schema:
type: string
responses:
'204':
description: Transcription deleted
# Sentiment API
/sentiment:
get:
tags: [Sentiment]
summary: List sentiment analyses
operationId: listSentimentAnalyses
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- name: status
in: query
schema: