API endpoint to search similarity using a song identifier

v1.0.0

Endpoint for an end-user client to search similarity by song identifier.

If you want to run the /similarity/by_song operation, you can do so via an HTTP GET command to the following URL:

Input

{
  "type": "object",
  "properties": {
    "song_id": {
      "type": "integer"
    }
  },
  "required": [
    "song_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "error": {
      "type": "boolean",
      "description": "Whether or not the request was successfully processed or not."
    },
    "message": {
      "type": "string",
      "description": "Error message if the request was unsuccessful."
    },
    "response": {
      "type": "object",
      "description": "Contains the response data if the request was successful.",
      "properties": {
        "similarity_list": {
          "type": "array",
          "description": "Contains all the similarity items representing songs.",
          "items": {
            "type": "object",
            "description": "Song similarity item.",
            "properties": {
              "artist_name": {
                "type": "string",
                "description": "Artist's song name."
              },
              "artist_url": {
                "type": "string",
                "description": "Artist URL."
              },
              "id": {
                "type": "integer",
                "description": "Song internal identifier."
              },
              "index_id": {
                "type": "integer",
                "description": "Index internal identifier."
              },
              "lyrics": {
                "type": "string",
                "description": "Song lyrics."
              },
              "percentage": {
                "type": "number",
                "format": "float",
                "description": "Similarity percentage."
              },
              "song_name": {
                "type": "string",
                "description": "Song name."
              },
              "song_url": {
                "type": "string",
                "description": "Song URL."
              }
            }
          }
        }
      }
    }
  }
}