Browse categories

Demo documentation

Configuring a Lyrics Source Manually

Use LRCLIB as an example while learning to configure any compatible lyrics provider.

Last updated

On this page

Let’s use LRCLIB as an example to demonstrate every part of a manually configured source. LRCLIB is a recommended option for getting started, but Codafy is provider-independent: you can substitute another service and map its query parameters and JSON response fields using the same process.

Add the source details

In Settings > Lyrics, select Add Source and enter:

Field Value
Source Name LRCLIB
Base URL https://lrclib.net
Endpoint /api/search

The base URL contains only the HTTPS scheme and domain. The endpoint is the path after the domain. Do not add query parameters to either field.

LRCLIB source name, base URL, and endpoint entered in Codafy
Enter the provider name, base URL, and search endpoint.

Map the query parameters

Select Add Parameter four times and configure:

Parameter name Codafy track field
track_name Title
artist_name Artist
album_name Album
duration Duration

Codafy replaces these mappings with the current track’s metadata. Duration is sent as whole seconds.

Example request URL
https://lrclib.net/api/search?track_name=Yellow&artist_name=Coldplay&album_name=Parachutes&duration=269
LRCLIB query parameters mapped to the corresponding Codafy track fields
Map each provider parameter to the matching track field.

Map the response fields

For this example, use the field names returned by each LRCLIB result object. When configuring another provider, replace these values with the equivalent fields in that provider’s response:

Setting Value
Title field trackName
Artist field artistName
Duration field duration
Synced lyrics field syncedLyrics
Plain lyrics field plainLyrics
Response type Array [ { ... } ]

At least one lyrics field is required. Synchronized lyrics should contain LRC-style timestamps such as [00:12.50].

LRCLIB response fields, final URL sample, and array response type configured in Codafy
Confirm the final URL sample, response mappings, and response type.

Test and save

  1. Select Test Source.
  2. Wait for Testing… to change to Success.
  3. Select Save.

Editing a field after a successful test requires another test. A successful connectivity test confirms an HTTP success response and valid JSON, but it does not guarantee that every response field is mapped correctly.

Successful LRCLIB source test with the Save action available
A successful test enables Save.
LRCLIB displayed in the Codafy lyrics Sources list
The saved source appears in priority order.

If the test fails or the source saves without finding lyrics, open Troubleshooting lyrics sources.