CodafyGet the app
Menu
Browse categories

Demo documentation

Lyrics Source Snapshot Reference

Review the JSON structure and allowed values used for clipboard source imports.

Last updated

On this page

Use this reference when preparing any compatible provider for clipboard import. Property names and enum values are case-sensitive. LRCLIB is shown as a complete example; replace its endpoint and mappings when using a different provider.

Example: LRCLIB source snapshot

LRCLIB snapshot
{
  "name": "LRCLIB",
  "baseURL": "https://lrclib.net",
  "endpoint": "/api/search",
  "queryParameters": [
    { "name": "track_name", "field": "title" },
    { "name": "artist_name", "field": "artist" },
    { "name": "album_name", "field": "album" },
    { "name": "duration", "field": "duration" }
  ],
  "trackMatchField": "trackName",
  "artistMatchField": "artistName",
  "durationMatchField": "duration",
  "syncedLyricsField": "syncedLyrics",
  "plainLyricsField": "plainLyrics",
  "responseType": "array"
}

Property reference

Property Required Purpose
name Yes Name displayed in Codafy.
baseURL Yes HTTPS scheme and domain without the endpoint or query string.
endpoint Yes Search path appended to baseURL.
queryParameters Yes Provider parameter names mapped to Codafy track fields.
trackMatchField Yes Response field containing the track title.
artistMatchField Present; may be empty Response field containing the artist.
durationMatchField Present; may be empty Response field containing duration in seconds.
syncedLyricsField Present; may be empty Response field containing timestamped lyrics.
plainLyricsField Present; may be empty Response field containing plain lyrics.
responseType Yes array for a top-level list or object for one result.

Allowed values

Each queryParameters[].field must be one of:

  • title
  • artist
  • album
  • duration

The responseType must be array or object. At least one query parameter and one lyrics field are required.

Validate before sharing

Before publishing a snapshot:

  1. Import it into Codafy from a clean clipboard.
  2. Confirm that the automatic test succeeds.
  3. Play a known matching track and verify the expected lyrics type.
  4. Confirm the provider’s usage and attribution requirements.