-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
4448 lines (4374 loc) · 150 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.1
info:
title: Partner Content API
description: >-
Epidemic Sound has transformed the soundtracking experience for global
brands and professional creators, with an expansive catalog of world-class
music and sound effects that's seen and heard over 2.5 billion times a day
around the globe.
Providing a direct license model that comes with all rights included and
next-generation soundtracking tools, Epidemic Sound empowers creators to
unlock more feeling in everything they create and share their stories with
the world. Epidemic Sound continuously enriches its world-class catalog of
music by teaming up with artists, composers, and producers to create tracks
spanning all genres, while supporting them financially and creatively.
version: 0.1.17
servers:
- description: Epidemic Sound Content API
url: https://partner-content-api.epidemicsound.com
tags:
- description: Endpoints to get track specific information.
name: Tracks
- description: >-
These endpoints will allow you to explore the Epidemic Sound library. You
can display tracks grouped in curated playlists, moods or genres or use
search to get tracks by any term.
name: Browse & search
- description: >-
These endpoints allows your application to upload assets such as images or
audio.
name: Assets
- description: >-
Endpoints to get sound effect specific information. These endpoints allow
you to build a UI to browse and search for sound effects.
name: Sound effects
- description: >-
These endpoints allows your application to get user specific information
such as liked sounds.
name: Users
- description: Endpoints for user authentication.
name: Authentication
- description: >-
These endpoints will allow you to report how tracks are used in your
application.
name: Reporting
paths:
/v0/collections:
get:
tags:
- Browse & search
summary: List collections with tracks
operationId: GET_Collections
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: >-
The collections endpoint returns playlists curated by our team of
in-house experts.
We offer collections for any occasion: from holidays like “Día de
Muertos“ to content types like “Real Estate” or “Badass ads”.
You can manage the order and which collections are part or your
applications’ free tier via the developer portal. As default, we return
the collections included in your free tier first, followed by all
collections in the Epidemic Sound library.
Collections have attributes like title and cover art. In the few cases
where we do not have cover art for a collection we return a default
image.
You can choose to return collections with or without tracks. The
response will include a maximum of 20 tracks per collection. If a
collection contains more than 20 tracks use endpoint
'/collections/{collectionId}' to get all tracks.
parameters:
- $ref: '#/components/parameters/excludeField'
- description: >-
Max number of entries returned in the response, default 10 and max
20
name: limit
in: query
required: false
schema:
type: integer
format: int32
- $ref: '#/components/parameters/offset'
responses:
'200':
description: Collection response
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionsPaginatedResponse'
example:
collections:
- id: 4caef099-43bd-4653-8203-3086fa01d3b7
name: Happy
tracks:
- title: Happy Song
id: 6rUPerw2po
mainArtists:
- Main Artist
featuredArtists:
- Featured Artist
bpm: 135
length: 3123
moods:
- id: happy
name: Happy
- id: eccentric
name: Eccentric
genres:
- id: beats
name: Beats
parent:
id: parent
name: Parent Beats
- id: trap
name: Trap
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/128x128.jpg
waveformUrl: >-
https://pdn.epidemicsound.com/waveforms/1600/394079.json
hasVocals: true
added: '2020-10-10'
isExplicit: false
isPreviewOnly: true
availableTracks: 1
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/128x128.jpg
- id: 9917d694-511b-4b66-ab8a-c553660399e4
name: Sad
tracks:
- title: Sad Song
id: 0dZCtol3bs
mainArtists:
- Main Artist
featuredArtists:
- Featured Artist
bpm: 97
length: 2976
moods:
- id: happyX
name: Happy
- id: eccentricX
name: Eccentric
genres:
- id: beatsX
name: Beats
parent:
id: parentX
name: Parent Beats
- id: trapX
name: Trap
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/128x128.jpg
waveformUrl: >-
https://pdn.epidemicsound.com/waveforms/1600/394079.json
hasVocals: true
added: '2020-10-10'
isExplicit: false
isPreviewOnly: true
availableTracks: 1
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/128x128.jpg
pagination:
page: 3
limit: 20
offset: 40
links:
next: /v0/collections?limit=20&offset=60
prev: /v0/collections?limit=20&offset=20
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
/v0/collections/{collectionId}:
get:
tags:
- Browse & search
summary: List all tracks in a collection
operationId: GET_Collection
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: >-
The collections endpoint allows you to list all the tracks in a specific
collection.
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: Collection response
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionPaginatedResponse'
example:
id: f10e65eb-9998-4c41-9777-ac9183ab85dd
name: Happy
tracks:
- title: Happy Song
id: 6rUPerw2poX
mainArtists:
- Main Artist
featuredArtists:
- Featured Artist
bpm: 135
length: 3123
moods:
- id: happyX
name: Happy
- id: eccentricX
name: Eccentric
genres:
- id: beatsX
name: Beats
parent:
id: parentX
name: Parent Beats
- id: trapX
name: Trap
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/128x128.jpg
waveformUrl: https://pdn.epidemicsound.com/waveforms/1600/394079.json
hasVocals: true
added: '2020-10-10'
isExplicit: false
isPreviewOnly: true
availableTracks: 1
pagination:
page: 4
limit: 20
offset: 60
links:
next: >-
/v0/collections/f10e65eb-9998-4c41-9777-ac9183ab85dd?limit=20&offset=80
prev: >-
/v0/collections/f10e65eb-9998-4c41-9777-ac9183ab85dd?limit=20&offset=40
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/default/128x128.jpg
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Bad request
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'404':
description: Collection was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Collection was not found
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
/v0/tracks:
get:
tags:
- Tracks
summary: List tracks based on mood, genre or BPM
operationId: GET_Tracks
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: >-
The tracks endpoint allows you to list all tracks based on a specified
mood, genre or BPM.
parameters:
- $ref: '#/components/parameters/genre'
- $ref: '#/components/parameters/mood'
- $ref: '#/components/parameters/bpmMin'
- $ref: '#/components/parameters/bpmMax'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: Tracks response
content:
application/json:
schema:
$ref: '#/components/schemas/TracksResponse'
example:
tracks:
- title: Happy Song
id: 6rUPerw2poX
mainArtists:
- Main Artist
featuredArtists:
- Featured Artist
bpm: 135
length: 3123
moods:
- id: happyX
name: Happy
- id: eccentricX
name: Eccentric
genres:
- id: beatsX
name: Beats
parent:
id: parentX
name: Parent Beats
- id: trapX
name: Trap
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/128x128.jpg
waveformUrl: https://pdn.epidemicsound.com/waveforms/1600/394079.json
hasVocals: true
added: '2020-10-10'
isExplicit: false
isPreviewOnly: true
- title: Sad Song
id: 0dZCtol3bsX
mainArtists:
- Main Artist
featuredArtists:
- Featured Artist
bpm: 97
length: 2976
moods:
- id: happyX
name: Happy
- id: eccentricX
name: Eccentric
genres:
- id: beatsX
name: Beats
parent:
id: parentX
name: Parent Beats
- id: trapX
name: Trap
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/128x128.jpg
waveformUrl: https://pdn.epidemicsound.com/waveforms/1600/394079.json
hasVocals: true
added: '2020-10-10'
isExplicit: false
isPreviewOnly: true
pagination:
page: 4
limit: 20
offset: 60
links:
next: /v0/tracks?limit=20&offset=80
prev: /v0/tracks?limit=20&offset=40
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Bad request
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
/v0/tracks/search:
get:
tags:
- Browse & search
summary: Search for tracks
operationId: BrowseSearch_tracksSearchList
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: >-
The search endpoint allows your users to search the entire Epidemic
Sound library. Search indexes track attributes such as moods, genres,
artist, song title and bpm.
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/term'
- $ref: '#/components/parameters/genre'
- $ref: '#/components/parameters/mood'
- description: Sort for search
name: sort
in: query
required: false
schema:
type: string
enum:
- Relevance
- Date
- Title
default: Relevance
- description: Order
name: order
in: query
required: false
schema:
type: string
enum:
- Asc
- Desc
default: Asc
responses:
'200':
description: Tracks response
content:
application/json:
schema:
$ref: '#/components/schemas/TracksResponse'
example:
tracks:
- title: Happy Song
id: 6rUPerw2poX
mainArtists:
- Main Artist
featuredArtists:
- Featured Artist
bpm: 135
length: 3123
moods:
- id: happyX
name: Happy
- id: eccentricX
name: Eccentric
genres:
- id: beatsX
name: Beats
parent:
id: parentX
name: Parent Beats
- id: trapX
name: Trap
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/128x128.jpg
waveformUrl: https://pdn.epidemicsound.com/waveforms/1600/394079.json
hasVocals: true
added: '2020-10-10'
isExplicit: false
isPreviewOnly: true
- title: Sad Song
id: 0dZCtol3bsX
mainArtists:
- Main Artist
featuredArtists:
- Featured Artist
bpm: 97
length: 2976
moods:
- id: happyX
name: Happy
- id: eccentricX
name: Eccentric
genres:
- id: beatsX
name: Beats
parent:
id: parentX
name: Parent Beats
- id: trapX
name: Trap
images:
default: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
L: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/1050x1050.jpg
M: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/600x600.jpg
S: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/300x300.jpg
XS: >-
https://cdn.epidemicsound.com/curation-assets/commercial-release-cover-images/123456/128x128.jpg
waveformUrl: https://pdn.epidemicsound.com/waveforms/1600/394079.json
hasVocals: true
added: '2020-10-10'
isExplicit: false
isPreviewOnly: true
pagination:
page: 2
limit: 25
offset: 25
links:
next: /v0/tracks/search?limit=25&offset=50
prev: /v0/tracks/search?limit=25&offset=0
aggregations:
moods:
- id: energetic
name: Energetic
count: 1
genres:
- id: rock
name: Rock
count: 1
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Bad request
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'403':
description: >-
Forbidden. Only available for ES Connect tokens or User tokens when
the app allows to preview tracks.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Forbidden
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
'503':
description: Service unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Service unavailable
/v0/tracks/search/suggestions:
get:
tags:
- Browse & search
summary: Search tracks suggestions
operationId: BrowseSearch_trackSuggestionsGet
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: >-
The search suggestions endpoint allows your users to get autocomplete
suggestions for Epidemic Sound music
parameters:
- $ref: '#/components/parameters/term'
responses:
'200':
description: Tracks Search Suggestions response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchSuggestionsResponse'
example:
suggestions:
- value: rock
type: TEXT
- value: rocker
type: TEXT
- value: rock n roll
type: TEXT
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Bad request
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'403':
description: >-
Forbidden. Only available for ES Connect tokens or User tokens when
the app allows to preview tracks.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Forbidden
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
'503':
description: Service unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Service unavailable
/v0/tracks/parameters:
get:
tags:
- Tracks
summary: List track parameters
operationId: Tracks_listParameters
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: Get a list of possible track query parameters
responses:
'200':
description: Track parameters response
content:
application/json:
schema:
$ref: '#/components/schemas/TrackParametersResponse'
example:
genres:
- id: rockX
name: Rock
parent:
id: rock-parent
name: Rock Parent
- id: rock-parentX
name: Rock Parent
- id: skate-punk
name: Skate-Punk
moods:
- id: energeticX
name: Energetic
- id: happyX
name: Happy
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
/v0/moods:
get:
tags:
- Browse & search
summary: List moods
operationId: BrowseSearch_moodsList
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: >-
The moods endpoint allows your users to browse the music catalog based
on moods like happy, epic or relaxing. Moods have cover art that you can
show in your interface.
By specifying the “type” of moods you want to display, you can choose to
show all moods in the Epidemic Sound library, only the moods that are
featured on epidemicsound.com or only the moods that are available for
your free tier tracks.
parameters:
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/type'
- description: >-
Max number of entries returned in the response, default 20 and max
20
name: limit
in: query
required: false
schema:
type: integer
format: int32
- $ref: '#/components/parameters/offset'
responses:
'200':
description: Track moods response
content:
application/json:
schema:
$ref: '#/components/schemas/MoodsPaginatedResponseWithImages'
example:
moods:
- id: energeticX
name: Epic
images:
default: >-
https://images.ctfassets.net/ojtnytzl1djm/3IWOMuMQtqXI01euQ43r6d/19761430ed16d9d35b94b71cb4693c80/Epic.jpg?w=300&h=300&fit=fill&q=90&fm=jpg
L: >-
https://images.ctfassets.net/ojtnytzl1djm/3IWOMuMQtqXI01euQ43r6d/19761430ed16d9d35b94b71cb4693c80/Epic.jpg?w=1050&h=1050&fit=fill&q=90&fm=jpg
M: >-
https://images.ctfassets.net/ojtnytzl1djm/3IWOMuMQtqXI01euQ43r6d/19761430ed16d9d35b94b71cb4693c80/Epic.jpg?w=600&h=600&fit=fill&q=90&fm=jpg
S: >-
https://images.ctfassets.net/ojtnytzl1djm/3IWOMuMQtqXI01euQ43r6d/19761430ed16d9d35b94b71cb4693c80/Epic.jpg?w=300&h=300&fit=fill&q=90&fm=jpg
XS: >-
https://images.ctfassets.net/ojtnytzl1djm/3IWOMuMQtqXI01euQ43r6d/19761430ed16d9d35b94b71cb4693c80/Epic.jpg?w=128&h=128&fit=fill&q=90&fm=jpg
- id: happyX
name: Happy
images:
default: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=300&h=300&fit=fill&q=90&fm=jpg
L: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=1050&h=1050&fit=fill&q=90&fm=jpg
M: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=600&h=600&fit=fill&q=90&fm=jpg
S: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=300&h=300&fit=fill&q=90&fm=jpg
XS: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=128&h=128&fit=fill&q=90&fm=jpg
pagination:
page: 1
limit: 20
offset: 0
links: {}
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
/v0/moods/{moodId}:
get:
tags:
- Browse & search
summary: Mood by ID
operationId: BrowseSearch_moodDetails
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: Get mood details
parameters:
- $ref: '#/components/parameters/moodId'
- $ref: '#/components/parameters/expand'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: Track mood response
content:
application/json:
schema:
$ref: '#/components/schemas/MoodResponseWithImages'
example:
id: happyX
name: Happy
images:
default: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=300&h=300&fit=fill&q=90&fm=jpg
L: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=1050&h=1050&fit=fill&q=90&fm=jpg
M: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=600&h=600&fit=fill&q=90&fm=jpg
S: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=300&h=300&fit=fill&q=90&fm=jpg
XS: >-
https://images.ctfassets.net/ojtnytzl1djm/2u0eIu3GfevvONKEVc0NEi/f0db82add464ad37ec90406c8ab7cab1/Happy.png?w=128&h=128&fit=fill&q=90&fm=jpg
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Invalid credentials
'404':
description: Mood was not found
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Mood was not found
'429':
description: Rate limit exceeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
message: Rate limit exceeded
/v0/genres:
get:
tags:
- Browse & search
summary: List genres
operationId: BrowseSearch_genreCatalog
security:
- UserAuth: []
- EpidemicSoundConnectAuth: []
description: >-
The genres endpoint allows your users to browse the music catalog based
on genres like rock, hiphop or acoustic.
Genres are nested and both parent and child genres are returned in the
response. Parent genres have cover art that you can show in your
interface.
By specifying the “type” of genres you want to display, you can choose
to show all genres in the Epidemic Sound library, only the genres that
are featured on epidemicsound.com or only the genres that are available
for your free tier tracks.
parameters:
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/type'
- description: >-
Max number of entries returned in the response, default 20 and max
20
name: limit
in: query
required: false
schema:
type: integer
format: int32
- $ref: '#/components/parameters/offset'
responses:
'200':
description: Track genres response
content:
application/json:
schema:
$ref: '#/components/schemas/GenresWithImagesPaginatedResponse'
example:
genres:
- id: beatsX
name: Beats
images:
default: >-
https://images.ctfassets.net/ojtnytzl1djm/4Mm4kJ9nwasLwZpQ54472a/90f35901413025d5a627fa132f6c2b56/Beats.jpg?w=300&h=300&fit=fill&q=90&fm=jpg
L: >-
https://images.ctfassets.net/ojtnytzl1djm/4Mm4kJ9nwasLwZpQ54472a/90f35901413025d5a627fa132f6c2b56/Beats.jpg?w=1050&h=1050&fit=fill&q=90&fm=jpg
M: >-
https://images.ctfassets.net/ojtnytzl1djm/4Mm4kJ9nwasLwZpQ54472a/90f35901413025d5a627fa132f6c2b56/Beats.jpg?w=600&h=600&fit=fill&q=90&fm=jpg
S: >-
https://images.ctfassets.net/ojtnytzl1djm/4Mm4kJ9nwasLwZpQ54472a/90f35901413025d5a627fa132f6c2b56/Beats.jpg?w=300&h=300&fit=fill&q=90&fm=jpg
XS: >-
https://images.ctfassets.net/ojtnytzl1djm/4Mm4kJ9nwasLwZpQ54472a/90f35901413025d5a627fa132f6c2b56/Beats.jpg?w=128&h=128&fit=fill&q=90&fm=jpg
pagination:
page: 1
limit: 20
offset: 0
links: {}
'401':
description: Unauthorized. Most likely your access token has expired.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'