Asuarez

SearchLy API v1

Introduction The SearchLy API provides similarity searching based on song lyrics. Operations The API allows for the /similarity/by_song operation, which…

Media & content#openapi#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Introduction

The SearchLy API provides similarity searching based on song lyrics.

Operations

The API allows for the /similarity/by_song operation, which allows clients to search the similarity for an existing song in the database. Also, the API has an additional /similarity/by_content endpoint which allows clients to search similarity given a free String input through a JSON request body. Additional /song/search operation is available for searching songs given a query String.

Endpoint

The API endpoint for the SearchLy API v1 is as follows:

https://searchly.asuarez.dev/api/v1

Motivation

This project was built in order to create an API for searching similarities based on song lyrics. There are a lot of songs in the industry and most of them are talking about the same topic. What I wanted to prove with SearchLy was to estimate how similar are two songs between them based on the meaning of their lyrics.

SearchLy is using a database of 100k songs from AZLyrics, using this scraper, which is being updated periodically. Then, using word2vec and NMSLIB, it was possible to create an index where you can search similarities using the k-nearest neighbors (KNN) algorithm.

> Note: I am currently using a micro-instance from DigitalOcean where the API is deployed, so you should expect a bad performance. However, if this API becomes popular I will deploy it in a bigger instance.

Endpoints 3

similarity

  • POSTAPI endpoint to search similarity using content/similarity/by_contentEndpoint for an end-user client to search similarity by content. If you want to run the /similarity/by_content operation, you can do so via an HTTP POST…
  • GETAPI endpoint to search similarity using a song identifier/similarity/by_song?song_id=234Endpoint 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…

song

  • GETAPI endpoint to search songs from the database given a query/song/search?query=Miley CyrusEndpoint for an end-user client to search songs from the database given a String query. If you want to run the /song/search operation, you can do so via an…

API details

Base URL
https://searchly.asuarez.dev/api/v1
Authentication
None declared in the description
Operations
3 operations on 3 pathsGET 2POST 1
Main resources
similarity 2song 1
Response formats
application/json application/text
Description format
OpenAPI 3.0.1, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the SearchLy API v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the SearchLy API v1 collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “API endpoint to search similarity using content” (POST /similarity/by_content), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the SearchLy API v1?

Introduction The SearchLy API provides similarity searching based on song lyrics. Operations The API allows for the /similarity/by_song operation, which… It is listed under Media & content and has 3 endpoints.

Who publishes the SearchLy API v1?

It is listed from Asuarez's public API description (an OpenAPI document), not published by Asuarez on Swastik Codes. Anyone who controls asuarez.dev can claim the profile by adding a DNS TXT record.

What is the base URL of the SearchLy API v1?

Requests go to https://searchly.asuarez.dev/api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the SearchLy API v1?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the SearchLy API v1 have?

3 operations on 3 paths (2 GET, 1 POST). The largest groups are similarity, song.

Is forking the SearchLy API v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.