Skip to content

APIs and Controller

hickmott99 edited this page Oct 1, 2022 · 27 revisions

describe how your front-end would communicate with your engine: list and describe your APIs. This is only your initial design, you can change them again later, but you should start thinking about and designing how your front end will communicate with your engine. If you're using existing OS subsystem(s) or 3rd-party SDK(s) to implement your engine, describe how you will interact with these.

API:

Identify Song Clip - Custom ML Model

Endpoint: GET /identifysong/ Input audio clip to ML model

Flask API endpoint to call our machine learning model

Returns: Artists and Title of input audio clip

Identify Song Clip - Shazamkit

Endpoint: GET /identifysongShazam/ Input audio clip to Shazamkit API

Flask API endpoint to call Shazamkit API machine learning model

Returns: Artists and Title of input audio clip

Get Song Information

Endpoint: GET /songinfo/

Calls AWS backend search engine to retrieve relevant movie/song information

Returns: relevant information about movies containing a given song.

Open Song in 3rd Party Apps

Ability to open up song/movie [info] in other applications (e.g. spotify, youtube, google)

Returns: relevant information about a given song.

Clone this wiki locally