{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ai:epidemic-sound/get-collections":{"get":{"operationId":"ai_epidemic_sound_get_collections","summary":"List collections with tracks","description":"GET /v0/collections","tags":["ai"],"parameters":[{"name":"excludeField","in":"query","required":false,"description":"Add parameter if tracks should be excluded in the response","schema":{"type":"string","enum":["tracks"],"description":"Add parameter if tracks should be excluded in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 10 and max 20","schema":{"type":"integer","description":"Max number of entries returned in the response, default 10 and max 20"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/get-collection":{"get":{"operationId":"ai_epidemic_sound_get_collection","summary":"List all tracks in a collection","description":"GET /v0/collections/{collectionId}","tags":["ai"],"parameters":[{"name":"collectionId","in":"query","required":true,"description":"Collection id","schema":{"type":"string","description":"Collection id"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/get-tracks":{"get":{"operationId":"ai_epidemic_sound_get_tracks","summary":"List tracks based on mood, genre or BPM","description":"GET /v0/tracks","tags":["ai"],"parameters":[{"name":"genre","in":"query","required":false,"description":"Id for genre","schema":{"type":"array","description":"Id for genre"}},{"name":"mood","in":"query","required":false,"description":"Id for mood","schema":{"type":"array","description":"Id for mood"}},{"name":"bpmMin","in":"query","required":false,"description":"BPM Min","schema":{"type":"integer","description":"BPM Min"}},{"name":"bpmMax","in":"query","required":false,"description":"BPM Max","schema":{"type":"integer","description":"BPM Max"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/browse-search-tracks-search-list":{"get":{"operationId":"ai_epidemic_sound_browse_search_tracks_search_list","summary":"Search for tracks","description":"GET /v0/tracks/search","tags":["ai"],"parameters":[{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"term","in":"query","required":false,"description":"Term for search","schema":{"type":"string","description":"Term for search"}},{"name":"genre","in":"query","required":false,"description":"Id for genre","schema":{"type":"array","description":"Id for genre"}},{"name":"mood","in":"query","required":false,"description":"Id for mood","schema":{"type":"array","description":"Id for mood"}},{"name":"sort","in":"query","required":false,"description":"Sort for search","schema":{"type":"string","enum":["Relevance","Date","Title"],"default":"Relevance","description":"Sort for search"}},{"name":"order","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["Asc","Desc"],"default":"Asc","description":"Order"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/browse-search-track-suggestions-get":{"get":{"operationId":"ai_epidemic_sound_browse_search_track_suggestions_get","summary":"Search tracks suggestions","description":"GET /v0/tracks/search/suggestions","tags":["ai"],"parameters":[{"name":"term","in":"query","required":false,"description":"Term for search","schema":{"type":"string","description":"Term for search"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-list-parameters":{"get":{"operationId":"ai_epidemic_sound_tracks_list_parameters","summary":"List track parameters","description":"GET /v0/tracks/parameters","tags":["ai"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/browse-search-moods-list":{"get":{"operationId":"ai_epidemic_sound_browse_search_moods_list","summary":"List moods","description":"GET /v0/moods","tags":["ai"],"parameters":[{"name":"sort","in":"query","required":false,"description":"Sorting options. Available values: alphabetic, relevance","schema":{"type":"string","enum":["alphabetic","relevance"],"default":"relevance","description":"Sorting options. Available values: alphabetic, relevance"}},{"name":"order","in":"query","required":false,"description":"Order options. Available values: asc, desc","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Order options. Available values: asc, desc"}},{"name":"type","in":"query","required":false,"description":"Types to filter by: * `all` - all the objects in the Epidemic Sound library * `partner-tier` - objects available to the partner within…","schema":{"type":"string","enum":["all","featured","partner-tier"],"default":"all","description":"Types to filter by: * `all` - all the objects in the Epidemic Sound library * `partner-tier` - objects available to the partner within…"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 20 and max 20","schema":{"type":"integer","description":"Max number of entries returned in the response, default 20 and max 20"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/browse-search-mood-details":{"get":{"operationId":"ai_epidemic_sound_browse_search_mood_details","summary":"Mood by ID","description":"GET /v0/moods/{moodId}","tags":["ai"],"parameters":[{"name":"moodId","in":"query","required":true,"description":"Mood id","schema":{"type":"string","description":"Mood id"}},{"name":"expand","in":"query","required":false,"description":"Add parameter if tracks should be included in the response","schema":{"type":"string","enum":["tracks"],"description":"Add parameter if tracks should be included in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/browse-search-genre-catalog":{"get":{"operationId":"ai_epidemic_sound_browse_search_genre_catalog","summary":"List genres","description":"GET /v0/genres","tags":["ai"],"parameters":[{"name":"sort","in":"query","required":false,"description":"Sorting options. Available values: alphabetic, relevance","schema":{"type":"string","enum":["alphabetic","relevance"],"default":"relevance","description":"Sorting options. Available values: alphabetic, relevance"}},{"name":"order","in":"query","required":false,"description":"Order options. Available values: asc, desc","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Order options. Available values: asc, desc"}},{"name":"type","in":"query","required":false,"description":"Types to filter by: * `all` - all the objects in the Epidemic Sound library * `partner-tier` - objects available to the partner within…","schema":{"type":"string","enum":["all","featured","partner-tier"],"default":"all","description":"Types to filter by: * `all` - all the objects in the Epidemic Sound library * `partner-tier` - objects available to the partner within…"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 20 and max 20","schema":{"type":"integer","description":"Max number of entries returned in the response, default 20 and max 20"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/browse-search-genre-details":{"get":{"operationId":"ai_epidemic_sound_browse_search_genre_details","summary":"Genre details","description":"GET /v0/genres/{genreId}","tags":["ai"],"parameters":[{"name":"genreId","in":"query","required":true,"description":"Genre id","schema":{"type":"string","description":"Genre id"}},{"name":"expand","in":"query","required":false,"description":"Add parameter if tracks should be included in the response","schema":{"type":"string","enum":["tracks"],"description":"Add parameter if tracks should be included in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/get-download":{"get":{"operationId":"ai_epidemic_sound_get_download","summary":"Download track","description":"GET /v0/tracks/{trackId}/download","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}},{"name":"format","in":"query","required":false,"description":"Track format","schema":{"type":"string","enum":["mp3"],"description":"Track format"}},{"name":"quality","in":"query","required":false,"description":"Track quality, normal is used as the default if not specified","schema":{"type":"string","enum":["normal","high"],"default":"normal","description":"Track quality, normal is used as the default if not specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-get-beats-data":{"get":{"operationId":"ai_epidemic_sound_tracks_get_beats_data","summary":"Beats","description":"GET /v0/tracks/{trackId}/beats","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-preview-using-cookies":{"get":{"operationId":"ai_epidemic_sound_tracks_preview_using_cookies","summary":"Preview track using cookies","description":"GET /v0/tracks/{trackId}/hls","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-get-similar":{"get":{"operationId":"ai_epidemic_sound_tracks_get_similar","summary":"Similar tracks","description":"GET /v0/tracks/{trackId}/similar","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-get-similar-segments":{"get":{"operationId":"ai_epidemic_sound_tracks_get_similar_segments","summary":"Similar track segment based on audio file","description":"GET /v0/tracks/similar-sections","tags":["ai"],"parameters":[{"name":"audioUploadId","in":"query","required":true,"description":"Reference to the uploaded audio file","schema":{"type":"string","description":"Reference to the uploaded audio file"}},{"name":"start","in":"query","required":true,"description":"Start of the section in milliseconds","schema":{"type":"integer","description":"Start of the section in milliseconds"}},{"name":"end","in":"query","required":true,"description":"End of the section in milliseconds","schema":{"type":"integer","description":"End of the section in milliseconds"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-find-similar-segments":{"get":{"operationId":"ai_epidemic_sound_tracks_find_similar_segments","summary":"Similar track segment based on trackID","description":"GET /v0/tracks/{trackId}/similar-sections","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}},{"name":"start","in":"query","required":true,"description":"Start of the section in milliseconds","schema":{"type":"integer","description":"Start of the section in milliseconds"}},{"name":"end","in":"query","required":true,"description":"End of the section in milliseconds","schema":{"type":"integer","description":"End of the section in milliseconds"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/get-stream":{"get":{"operationId":"ai_epidemic_sound_get_stream","summary":"Preview track","description":"GET /v0/tracks/{trackId}/stream","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-recommend-section":{"get":{"operationId":"ai_epidemic_sound_tracks_recommend_section","summary":"Recommend section of a track","description":"GET /v0/tracks/{trackId}/highlights","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}},{"name":"duration","in":"query","required":false,"description":"The highlight duration in seconds","schema":{"type":"array","description":"The highlight duration in seconds"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/assets-by-checksum-get":{"get":{"operationId":"ai_epidemic_sound_assets_by_checksum_get","summary":"Get audio asset by the checksum","description":"GET /v0/uploads/audio/{checksum}","tags":["ai"],"parameters":[{"name":"checksum","in":"query","required":true,"description":"File checksum","schema":{"type":"string","description":"File checksum"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/assets-delete-audio-file":{"post":{"operationId":"ai_epidemic_sound_assets_delete_audio_file","summary":"Delete a single audio file","description":"DELETE /v0/uploads/audio/{audioIdOrChecksum}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["audioIdOrChecksum"],"properties":{"audioIdOrChecksum":{"type":"string","description":"Audio upload id or checksum of audio file"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/assets-upload-audio-file":{"post":{"operationId":"ai_epidemic_sound_assets_upload_audio_file","summary":"Uploads an audio file","description":"POST /v0/uploads/audio","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/assets-delete-image":{"post":{"operationId":"ai_epidemic_sound_assets_delete_image","summary":"Delete uploaded image","description":"DELETE /v0/uploads/images/{imageId}","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["imageId"],"properties":{"imageId":{"type":"string","description":"Image id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/assets-upload-image-for-recommendation":{"post":{"operationId":"ai_epidemic_sound_assets_upload_image_for_recommendation","summary":"Upload image for recommendation","description":"POST /v0/uploads/images","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/assets-remove-all-images":{"post":{"operationId":"ai_epidemic_sound_assets_remove_all_images","summary":"Delete all the uploaded images by the user","description":"DELETE /v0/uploads/images","tags":["ai"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/tracks-matching-image-get":{"get":{"operationId":"ai_epidemic_sound_tracks_matching_image_get","summary":"Get tracks matching an image","description":"GET /v0/tracks/matching-image/{imageId}","tags":["ai"],"parameters":[{"name":"imageId","in":"query","required":true,"description":"Image id","schema":{"type":"string","description":"Image id"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"genre","in":"query","required":false,"description":"Id for genre","schema":{"type":"array","description":"Id for genre"}},{"name":"mood","in":"query","required":false,"description":"Id for mood","schema":{"type":"array","description":"Id for mood"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/sound-effects-list-categories":{"get":{"operationId":"ai_epidemic_sound_sound_effects_list_categories","summary":"Get a list of all sound effects categories","description":"GET /v0/sound-effects/categories","tags":["ai"],"parameters":[{"name":"type","in":"query","required":false,"description":"Category type","schema":{"type":"string","enum":["all","featured"],"default":"all","description":"Category type"}},{"name":"sort","in":"query","required":false,"description":"Sorting options","schema":{"type":"string","enum":["title","relevance"],"default":"title","description":"Sorting options"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/sound-effects-get-category-by-id":{"get":{"operationId":"ai_epidemic_sound_sound_effects_get_category_by_id","summary":"Get a sound effects category by id","description":"GET /v0/sound-effects/categories/{categoryId}","tags":["ai"],"parameters":[{"name":"categoryId","in":"query","required":true,"description":"Category id","schema":{"type":"string","description":"Category id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/sound-effects-get-by-category-tracks":{"get":{"operationId":"ai_epidemic_sound_sound_effects_get_by_category_tracks","summary":"Get sound effects by category","description":"GET /v0/sound-effects/categories/{categoryId}/tracks","tags":["ai"],"parameters":[{"name":"categoryId","in":"query","required":true,"description":"Category id","schema":{"type":"string","description":"Category id"}},{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"sort","in":"query","required":false,"description":"Sort","schema":{"type":"string","enum":["title","newest","length"],"default":"newest","description":"Sort"}},{"name":"order","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Order"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/sound-effects-download-sound-effect":{"get":{"operationId":"ai_epidemic_sound_sound_effects_download_sound_effect","summary":"Download sound effect","description":"GET /v0/sound-effects/{trackId}/download","tags":["ai"],"parameters":[{"name":"trackId","in":"query","required":true,"description":"Track id","schema":{"type":"string","description":"Track id"}},{"name":"format","in":"query","required":false,"description":"Track format","schema":{"type":"string","enum":["mp3"],"description":"Track format"}},{"name":"quality","in":"query","required":false,"description":"Track quality, normal is used as the default if not specified","schema":{"type":"string","enum":["normal","high"],"default":"normal","description":"Track quality, normal is used as the default if not specified"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/sound-effects-search-sound-effects":{"get":{"operationId":"ai_epidemic_sound_sound_effects_search_sound_effects","summary":"Search sound effects","description":"GET /v0/sound-effects/search","tags":["ai"],"parameters":[{"name":"offset","in":"query","required":false,"description":"Index of the entry track in the response","schema":{"type":"integer","description":"Index of the entry track in the response"}},{"name":"limit","in":"query","required":false,"description":"Max number of entries returned in the response, default 50 and max 100","schema":{"type":"integer","description":"Max number of entries returned in the response, default 50 and max 100"}},{"name":"term","in":"query","required":false,"description":"Term for search","schema":{"type":"string","description":"Term for search"}},{"name":"sort","in":"query","required":false,"description":"Sort for search","schema":{"type":"string","enum":["best-match","newest","popular","length","title"],"default":"best-match","description":"Sort for search"}},{"name":"order","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Order"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/reporting-epidemic-event-submission":{"post":{"operationId":"ai_epidemic_sound_reporting_epidemic_event_submission","summary":"Report events to Epidemic Sound","description":"POST /v0/analytics/report","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/post-use":{"post":{"operationId":"ai_epidemic_sound_post_use","summary":"Report usage","description":"POST /v0/usage","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/authentication-request-partner-token":{"post":{"operationId":"ai_epidemic_sound_authentication_request_partner_token","summary":"Request a partner token","description":"POST /v0/partner-token","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/authentication-request-user-token":{"post":{"operationId":"ai_epidemic_sound_authentication_request_user_token","summary":"Request a user token","description":"POST /v0/token","tags":["ai"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/users-get-details":{"get":{"operationId":"ai_epidemic_sound_users_get_details","summary":"User details","description":"GET /v0/users/me","tags":["ai"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/users-get-subscription-details":{"get":{"operationId":"ai_epidemic_sound_users_get_subscription_details","summary":"User subscription details","description":"GET /v0/users/me/subscription","tags":["ai"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:epidemic-sound/users-list-liked-tracks":{"get":{"operationId":"ai_epidemic_sound_users_list_liked_tracks","summary":"List users’ liked tracks","description":"GET /v0/users/me/liked/tracks","tags":["ai"],"parameters":[{"name":"offset","in":"query","required":false,"description":"Offset for the pagination. For this endpoint the number of results is fixed at 25, so the offset needs to be evenly divisible by 25.","schema":{"type":"integer","description":"Offset for the pagination. For this endpoint the number of results is fixed at 25, so the offset needs to be evenly divisible by 25."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}