Repository navigation
Expand file tree
/
Copy path1.0.json
More file actions
3105 lines (3105 loc) · 106 KB
/
Copy path1.0.json
File metadata and controls
3105 lines (3105 loc) · 106 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.2.0",
"info": {
"title": "DiffScope Synthesis Platform API",
"version": "1.0",
"description": "DSSP HTTP API surface represented by this service. A server implementation can support a subset of the broader DSSP API.\n\n## Streaming responses\n\n### Response negotiation\n\nOperations whose response content declares application/x-ndjson support streaming on the same URL with the same method and request body as the corresponding non-streaming operation. The Accept request header specifies acceptable response media types. Accept: application/x-ndjson requests a stream. Clients that can process NDJSON responses should prefer this media type when specifying Accept. Accept: application/json requests a non-streaming response. If both media types are acceptable, selection follows HTTP content negotiation, including quality values. If Accept is absent or contains only */*, the response uses application/json. The response Content-Type identifies the selected representation. Request bodies retain Content-Type: application/json.\n\n### NDJSON response format\n\nAn application/x-ndjson response is a UTF-8 sequence of JSON objects. Each object occupies a single line terminated by LF. Line breaks within JSON strings are escaped. Each line contains one event with the envelope {\"event\": \"<event name>\", \"data\": <event data>}. The data member is omitted for queue and is optional for progress. Each operation's itemSchema describes one event. Event ordering is governed by the following table and is not validated by itemSchema.\n\n| Event | Data | Meaning | Allowed next events |\n| --- | --- | --- | --- |\n| queue | Absent. | The task is queued on the server. Disconnecting in this state does not discard any unfinished processing progress. | queue, progress, result, error |\n| progress | Optional object {\"value\": <number from 0 to 1 inclusive>}. Absent data is equivalent to {\"value\": 0}. | The task is processing. The normalized value is solely for client progress display and has no business meaning. | progress, result, error |\n| result | Required. The complete response body defined for application/json by the same operation. | The task completed successfully. Results are returned in full in a single event. | None. This event is terminal. |\n| error | Required. The error data format is unspecified, as for non-streaming errors. | The task failed. | None. This event is terminal. |\n\nThe stream may begin with any event. Queue and progress events are optional. A completed stream contains exactly one terminal event, result or error, and no events follow it. A connection that closes before a terminal event does not establish task completion. A progress value of 1 does not replace a result event.\n\nA negotiated application/x-ndjson response always uses HTTP status 200, including if its first event is error. Request decoding, validation, architecture selection, task execution, and result encoding failures use an error event. The error data contains the corresponding problem response body. The status member in that body describes the failure and does not change the HTTP response status. If neither application/json nor application/x-ndjson is acceptable, the server returns HTTP 406.\n\nDuring queue and progress, the server repeats the current event at the configured heartbeat interval, including if the progress value is unchanged. The default interval is 10 seconds. Preparation does not produce progress events. Only the initial resource admission produces queue events. Subsequent resource waits retain the last progress state. Progress measures the task body from 0 to 1 and excludes preparation and final result construction or encoding. A value of 1 indicates completion of the task body. A later error event remains possible. Tasks without model work may return a terminal event directly.\n\nExample of a successful /synth/duration response:\n\n```ndjson\n{\"event\":\"queue\"}\n{\"event\":\"progress\"}\n{\"event\":\"progress\",\"data\":{\"value\":1}}\n{\"event\":\"result\",\"data\":{\"output\":{\"notes\":[]}}}\n```\n\n## Synthesis workflow\n\nSynthesis proceeds from score data through pronunciation, phonemes, phoneme timing, parameter curves, and encoded audio. Clients select stages from the chosen group's capabilities and supply existing or manually prepared data for stages that do not require automatic generation. Each request supplies its context and the complete input required by that stage. Clients retain the score and intermediate results and assemble subsequent requests from them.\n\n### Discovery and context\n\n1. Select an architecture through `GET /arch` and a singer through `GET /singer` or the architecture's singer endpoints. Use the singer's `arch` and `group` to obtain the corresponding group metadata through `GET /arch/{arch_id}/group/{group_id}`. Architecture metadata defines parameter properties. Group metadata defines available singing languages, conversion modes, duration prediction, parameter dependencies, audio dependencies, and mixing support.\n\n2. Construct `context.arch` from the selected architecture. Initialize `context.archExtra` from the architecture's `defaultArchExtra` and each singer source's `extra` from that singer's `defaultExtra`, applying any requested architecture-specific settings. Pronunciation and phoneme requests use `SingleSingerContext`. Duration, parameter, and audio requests use `MultiSingerContext`, including for a single source. Multiple sources must share an architecture and group, and the group must have `mixable=true`. Keep the source order consistent with the per-frame `mix` data.\n\n3. Select each note's singing language from the group's `languages` map. The singer's nonempty `defaultLanguage` provides a preferred language. `Accept-Language` selects metadata display text and does not select the singing language. `POST /synth/env-tag` returns an environment tag for the supplied synthesis context.\n\n### Pronunciation and phonemes\n\n1. For a language with `pronunciationMode=full`, call `POST /synth/pronunciation` with each note's lyric and language. Retain the returned pronunciation or select an alternative from its candidates. For `pronunciationMode=skip`, supply pronunciation directly. Existing pronunciations may also be used without conversion.\n\n2. For `phonemeMode=full` or `token_only`, call `POST /synth/phoneme` with the selected complete pronunciation and language for each note. Optional `syllableSliceStart` and `syllableSliceEnd` allocate syllable groups to a note. `full` supports tokens and syllable onset labels. `token_only` supports token conversion without onset labeling, so clients must supply any onset labels required by later stages. For `phonemeMode=skip`, supply phonemes directly.\n\n3. Assemble score notes with position, pitch in cents, pronunciation, language, allocated phonemes, and `kind`. Copy returned phoneme tokens and onset flags and add the appropriate phoneme language. Express a slur with `kind=slur`, an empty phoneme array, and zero gap. A slur cannot be the first note. Each note retains its own complete pronunciation and language. Pronunciation strings do not encode slurs or syllable allocation.\n\n### Phoneme timing\n\nPrepare `pieceDuration`, score notes, `mix`, and `mixSampleRate` for the piece. If the group has `durationMode=full`, call `POST /synth/duration`. Merge each returned `output.notes[i].phonemes[j].start` into the corresponding input phoneme, retaining the score fields, tokens, onset flags, and languages. The resulting timed notes are the input to parameter and audio generation. If `durationMode=skip`, supply phoneme starts directly. Existing or manually edited starts may also be used without prediction.\n\n### Parameter preparation\n\nStart with the group's `audioDependencies` to identify the curves required for audio generation. For every curve to be predicted, follow its `dependsOn` entries in `parameterPipeline` recursively. Prepare dependencies before dependent predictions. Parameters with `type=direct` are supplied by the client. Parameters with `type=indirect` may be supplied as existing curves or generated through `POST /synth/parameter`.\n\nEach parameter request supplies the timed notes, piece duration, mix data, and parameter curves with their sampling rates. Add `retake` only to parameters that require prediction. Supply dependency curves without `retake` to use them as conditions. Their presence does not request regeneration. A nonempty retake range uses frames on that parameter's input sampling grid. `retakeMode=full` requires the complete piece. `retakeMode=range` also permits subranges. A zero-length range performs no recomputation, and direct parameters cannot have a nonempty retake range.\n\nRetain the returned `output.parameters` curves and their returned sampling rates for subsequent requests. For example, if pitch depends on direct expressiveness and energy depends on pitch, supply expressiveness, predict pitch with `retake`, then supply the returned pitch without `retake` when predicting energy. If pitch or energy is already available, supply that curve directly and omit its prediction. After an edit, refresh affected timing and dependent curves before regenerating audio.\n\n### Audio generation\n\nCall `POST /synth/audio` with the prepared timed notes, piece duration, mix data, and all curves required by `audioDependencies`. Audio parameter entries contain values and sampling rates without `retake`. Audio generation does not implicitly predict missing parameters. Use `acceptableFormats` and `acceptableSchemes` to constrain the encoded audio representation and URL scheme. Retrieve or decode the audio identified by `output.audioUrl` according to its scheme.\n\nFor operations that declare NDJSON responses, the response negotiation and event rules apply to each stage independently. Consume a successful terminal `result` event before using its data as the next stage's input.\n\n### Long content and segmentation\n\nFor long synthesis content, clients should divide the score into segments at blank intervals between phrases and synthesize each segment separately. Choose boundaries within these intervals without splitting a sustained note or slur. Reserve a short leading margin before the first note for consonant onsets and a short trailing margin after the last note for vocal tails. The margins should accommodate the phoneme timing and vocal decay rather than end exactly at note boundaries.\n\nInclude both margins in each segment's `pieceDuration` and prepare its note timing, mix data, parameter curves, and retake ranges for the segment's local timeline. Retain the segment's offset in the original score. Place the generated audio at that offset, including the leading margin, so the notes remain aligned with the score. Preserve the original blank intervals and avoid trimming audible consonant onsets or vocal tails during assembly."
},
"servers": [
{
"url": "http://localhost:13711/v1",
"description": "Default local server URL. The actual host and port are configured by the service."
}
],
"tags": [
{
"name": "Application",
"description": "Application metadata endpoints."
},
{
"name": "Synthesis",
"description": "Synthesis service endpoints."
},
{
"name": "Extraction",
"description": "Audio analysis and extraction endpoints."
}
],
"paths": {
"/info": {
"get": {
"tags": [
"Application"
],
"operationId": "getApplicationInfo",
"summary": "Get application information",
"description": "Returns service application metadata.",
"responses": {
"200": {
"description": "Application information.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationInfoResponse"
}
}
}
}
}
}
},
"/arch": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchitectureList",
"summary": "List architectures",
"description": "Returns metadata for every registered architecture. Display language is specified via the Accept-Language request header.",
"responses": {
"200": {
"$ref": "#/components/responses/ArchitectureList"
}
}
}
},
"/arch/{arch_id}": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchitecture",
"summary": "Get architecture metadata",
"description": "Returns metadata for one registered architecture. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Architecture"
}
}
}
},
"/singer": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getSingerList",
"summary": "List all singers",
"description": "Returns singers from every registered architecture. Display language is specified via the Accept-Language request header.",
"responses": {
"200": {
"$ref": "#/components/responses/SingerList"
}
}
}
},
"/arch/{arch_id}/singer": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchSingerList",
"summary": "List singers for an architecture",
"description": "Returns singers from one registered architecture. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/ArchSingerList"
}
}
}
},
"/arch/{arch_id}/singer/{singer_id}": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchSinger",
"summary": "Get singer metadata",
"description": "Returns one singer from one registered architecture. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
},
{
"$ref": "#/components/parameters/SingerID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Singer"
}
}
}
},
"/arch/{arch_id}/singer/{singer_id}/avatar": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchSingerAvatar",
"summary": "Get singer avatar URL",
"description": "Returns the avatar URL for one singer. Display language is specified via the Accept-Language request header. Acceptable formats and schemes can be constrained through the acceptable_formats and acceptable_schemes query parameters.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
},
{
"$ref": "#/components/parameters/SingerID"
},
{
"$ref": "#/components/parameters/AcceptableFormats"
},
{
"$ref": "#/components/parameters/AcceptableSchemes"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SingerAvatar"
}
}
}
},
"/arch/{arch_id}/singer/{singer_id}/background": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchSingerBackground",
"summary": "Get singer background URL",
"description": "Returns the background image URL for one singer. Display language is specified via the Accept-Language request header. Acceptable formats and schemes can be constrained through the acceptable_formats and acceptable_schemes query parameters.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
},
{
"$ref": "#/components/parameters/SingerID"
},
{
"$ref": "#/components/parameters/AcceptableFormats"
},
{
"$ref": "#/components/parameters/AcceptableSchemes"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SingerBackground"
}
}
}
},
"/arch/{arch_id}/singer/{singer_id}/demo-audio": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchSingerDemoAudioList",
"summary": "List singer demo audio",
"description": "Returns demo audio entries for one singer. Display language is specified via the Accept-Language request header. Acceptable formats and schemes can be constrained through the acceptable_formats and acceptable_schemes query parameters.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
},
{
"$ref": "#/components/parameters/SingerID"
},
{
"$ref": "#/components/parameters/AcceptableFormats"
},
{
"$ref": "#/components/parameters/AcceptableSchemes"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SingerDemoAudioList"
}
}
}
},
"/arch/{arch_id}/group": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchGroupList",
"summary": "List groups for an architecture",
"description": "Returns groups from one registered architecture. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/GroupList"
}
}
}
},
"/arch/{arch_id}/group/{group_id}": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchGroup",
"summary": "Get group metadata",
"description": "Returns one group from one registered architecture. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
},
{
"$ref": "#/components/parameters/GroupID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Group"
}
}
}
},
"/arch/{arch_id}/group/{group_id}/singer": {
"get": {
"tags": [
"Synthesis"
],
"operationId": "getArchGroupSingerList",
"summary": "List singers for a group",
"description": "Returns singers from one registered group. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ArchID"
},
{
"$ref": "#/components/parameters/GroupID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/GroupSingerList"
}
}
}
},
"/synth/env-tag": {
"post": {
"tags": [
"Synthesis"
],
"operationId": "postSynthEnvTag",
"summary": "Get an environment tag",
"description": "Returns the environment tag for a synthesis context.",
"requestBody": {
"$ref": "#/components/requestBodies/EnvTagRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/EnvTagResult"
}
}
}
},
"/synth/pronunciation": {
"post": {
"tags": [
"Synthesis"
],
"operationId": "postSynthPronunciation",
"summary": "Generate pronunciations",
"description": "Generates pronunciation candidates for lyric input. Conversion capability is described by pronunciationMode for the selected singing language in the singer's group.",
"requestBody": {
"$ref": "#/components/requestBodies/PronunciationRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/PronunciationComplete"
}
}
}
},
"/synth/phoneme": {
"post": {
"tags": [
"Synthesis"
],
"operationId": "postSynthPhoneme",
"summary": "Generate phonemes",
"description": "Generates phoneme notes from pronunciation notes. Token conversion and onset-labeling capabilities are described by phonemeMode for the selected singing language in the singer's group.",
"requestBody": {
"$ref": "#/components/requestBodies/PhonemeRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/PhonemeComplete"
}
}
}
},
"/synth/duration": {
"post": {
"tags": [
"Synthesis"
],
"operationId": "postSynthDuration",
"summary": "Generate phoneme timing",
"description": "Generates phoneme timing for duration notes when the selected group has durationMode=full. Clients supply phoneme starts directly for later stages when durationMode=skip.",
"requestBody": {
"$ref": "#/components/requestBodies/DurationRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/DurationResult"
}
}
}
},
"/synth/parameter": {
"post": {
"tags": [
"Synthesis"
],
"operationId": "postSynthParameter",
"summary": "Generate parameter values",
"description": "Generates parameter values explicitly requested through retake. Consult the selected group's parameterPipeline for supported inputs, prediction dependencies, and full-piece or subrange retake capabilities. Parameters supplied without retake are conditions.",
"requestBody": {
"$ref": "#/components/requestBodies/ParameterRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/ParameterResult"
}
}
}
},
"/synth/audio": {
"post": {
"tags": [
"Synthesis"
],
"operationId": "postSynthAudio",
"summary": "Generate audio",
"description": "Generates encoded audio from prepared phoneme starts and parameter curves. The selected group's audioDependencies describes required parameter inputs. Formats and URL schemes can be constrained through acceptableFormats and acceptableSchemes.",
"requestBody": {
"$ref": "#/components/requestBodies/AudioRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/AudioResult"
}
}
}
},
"/extractor": {
"get": {
"tags": [
"Extraction"
],
"operationId": "getExtractorList",
"summary": "List extractors",
"description": "Returns the available note, tempo, pitch, and separation extractors. Display language is specified via the Accept-Language request header.",
"responses": {
"200": {
"$ref": "#/components/responses/ExtractorList"
}
}
}
},
"/extractor/note/{extractor_id}": {
"get": {
"tags": [
"Extraction"
],
"operationId": "getNoteExtractor",
"summary": "Get a note extractor",
"description": "Returns metadata for one note extractor. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ExtractorID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Extractor"
}
}
}
},
"/extractor/tempo/{extractor_id}": {
"get": {
"tags": [
"Extraction"
],
"operationId": "getTempoExtractor",
"summary": "Get a tempo extractor",
"description": "Returns metadata for one tempo extractor. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ExtractorID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Extractor"
}
}
}
},
"/extractor/pitch/{extractor_id}": {
"get": {
"tags": [
"Extraction"
],
"operationId": "getPitchExtractor",
"summary": "Get a pitch extractor",
"description": "Returns metadata for one pitch extractor. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ExtractorID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Extractor"
}
}
}
},
"/extractor/separation/{extractor_id}": {
"get": {
"tags": [
"Extraction"
],
"operationId": "getSeparationExtractor",
"summary": "Get a separation extractor",
"description": "Returns metadata for one separation extractor. Display language is specified via the Accept-Language request header.",
"parameters": [
{
"$ref": "#/components/parameters/ExtractorID"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/SeparationExtractor"
}
}
}
},
"/extract/note": {
"post": {
"tags": [
"Extraction"
],
"operationId": "postExtractNote",
"summary": "Extract notes from audio",
"description": "Extracts note timing and pitch from audio.",
"requestBody": {
"$ref": "#/components/requestBodies/NoteExtractionRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/NoteExtractionResult"
}
}
}
},
"/extract/tempo": {
"post": {
"tags": [
"Extraction"
],
"operationId": "postExtractTempo",
"summary": "Extract tempo from audio",
"description": "Extracts an ordered list of beats and downbeat indicators from audio.",
"requestBody": {
"$ref": "#/components/requestBodies/TempoExtractionRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/TempoExtractionResult"
}
}
}
},
"/extract/pitch": {
"post": {
"tags": [
"Extraction"
],
"operationId": "postExtractPitch",
"summary": "Extract pitch from audio",
"description": "Extracts a segmented pitch curve from audio.",
"requestBody": {
"$ref": "#/components/requestBodies/PitchExtractionRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/PitchExtractionResult"
}
}
}
},
"/extract/separation": {
"post": {
"tags": [
"Extraction"
],
"operationId": "postExtractSeparation",
"summary": "Separate audio",
"description": "Separates audio into its constituent tracks. Output formats and URL schemes are constrained by acceptableFormats and acceptableSchemes in the request body. The server currently returns only audio/wav data URLs, preserving the input sample rate without resampling; the input must use a sample rate accepted by the extractor. A nonempty preference list that excludes the supported output format or scheme is rejected with HTTP 422. Display language is specified via the Accept-Language request header.",
"requestBody": {
"$ref": "#/components/requestBodies/SeparationExtractionRequest"
},
"responses": {
"200": {
"$ref": "#/components/responses/SeparationExtractionResult"
}
}
}
}
},
"components": {
"parameters": {
"ArchID": {
"name": "arch_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Architecture identifier."
},
"SingerID": {
"name": "singer_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Singer reference understood by the selected architecture. DiffSinger uses package-id=version:singer/contribution-id with the exact package version. Preserve the returned reference and encode it once as a URI path component when used in a path."
},
"GroupID": {
"name": "group_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Group identifier within the selected architecture."
},
"ExtractorID": {
"name": "extractor_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Extractor identifier within the selected extraction capability."
},
"AcceptableFormats": {
"name": "acceptableFormats",
"in": "query",
"required": false,
"description": "Comma-separated MIME types the client accepts, in priority order. If omitted or empty, the server may return any URL.",
"style": "form",
"explode": false,
"allowEmptyValue": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "media-type"
},
"description": "MIME types the client expects to accept, in priority order. An empty list means the server may return any URL."
}
},
"AcceptableSchemes": {
"name": "acceptableSchemes",
"in": "query",
"required": false,
"description": "Comma-separated URL schemes the client accepts, in priority order. If omitted or empty, the server may return any URL.",
"style": "form",
"explode": false,
"allowEmptyValue": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "URL schemes the client expects to accept, in priority order. An empty list means the server may return any URL."
}
}
},
"requestBodies": {
"EnvTagRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvTagRequest"
}
}
}
},
"PronunciationRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PronunciationRequest"
}
}
}
},
"PhonemeRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhonemeRequest"
}
}
}
},
"DurationRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DurationRequest"
}
}
}
},
"ParameterRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParameterRequest"
}
}
}
},
"AudioRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioRequest"
}
}
}
},
"NoteExtractionRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteExtractionRequest"
}
}
}
},
"TempoExtractionRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TempoExtractionRequest"
}
}
}
},
"PitchExtractionRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PitchExtractionRequest"
}
}
}
},
"SeparationExtractionRequest": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeparationExtractionRequest"
}
}
}
}
},
"responses": {
"ArchitectureList": {
"description": "Architecture metadata from every registered architecture.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArchitectureMetadataList"
}
}
}
},
"Architecture": {
"description": "Architecture metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArchitectureMetadata"
}
}
}
},
"SingerList": {
"description": "Singer metadata from every registered architecture.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingerInfoList"
}
}
}
},
"ArchSingerList": {
"description": "Singer metadata from one registered architecture.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingerInfoList"
}
}
}
},
"Singer": {
"description": "Singer metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingerInfo"
}
}
}
},
"SingerAvatar": {
"description": "Singer avatar URL.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingerAvatarResponse"
}
}
}
},
"SingerBackground": {
"description": "Singer background URL.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingerBackgroundResponse"
}
}
}
},
"SingerDemoAudioList": {
"description": "Singer demo audio entries.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingerDemoAudioList"
}
}
}
},
"GroupList": {
"description": "Group metadata from one registered architecture.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupMetadataList"
}
}
}
},
"Group": {
"description": "Group metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupMetadata"
}
}
}
},
"GroupSingerList": {
"description": "Singer metadata from one registered group.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SingerInfoList"
}
}
}
},
"EnvTagResult": {
"description": "Environment tag for the supplied synthesis context.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvTagResponse"
}
}
}
},
"PronunciationComplete": {
"description": "Pronunciation generation result.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PronunciationResponse"
}
},
"application/x-ndjson": {
"itemSchema": {
"oneOf": [
{
"$ref": "#/components/schemas/QueueEvent"
},
{
"$ref": "#/components/schemas/ProgressEvent"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"event",
"data"
],
"properties": {
"event": {
"const": "result"
},
"data": {
"$ref": "#/components/schemas/PronunciationResponse"
}
}
},
{
"$ref": "#/components/schemas/ErrorEvent"
}
]
}
}
}
},
"PhonemeComplete": {
"description": "Phoneme generation result.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PhonemeResponse"
}
},
"application/x-ndjson": {
"itemSchema": {
"oneOf": [
{
"$ref": "#/components/schemas/QueueEvent"
},
{
"$ref": "#/components/schemas/ProgressEvent"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"event",
"data"
],
"properties": {
"event": {
"const": "result"
},
"data": {
"$ref": "#/components/schemas/PhonemeResponse"
}
}
},
{
"$ref": "#/components/schemas/ErrorEvent"
}
]
}
}
}
},
"DurationResult": {
"description": "Duration generation result.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DurationResponse"
}
},
"application/x-ndjson": {
"itemSchema": {
"oneOf": [
{
"$ref": "#/components/schemas/QueueEvent"
},
{
"$ref": "#/components/schemas/ProgressEvent"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"event",
"data"
],
"properties": {
"event": {
"const": "result"
},
"data": {
"$ref": "#/components/schemas/DurationResponse"
}
}
},
{
"$ref": "#/components/schemas/ErrorEvent"
}
]
}
}
}
},
"ParameterResult": {
"description": "Parameter generation result.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ParameterResponse"
}
},
"application/x-ndjson": {
"itemSchema": {