Browse categories

Demo documentation

Importing a Lyrics Source from the Clipboard

Import any compatible lyrics provider from a shared source snapshot.

Last updated

On this page

Clipboard import is the quickest way to install a source shared by a trusted website or support guide. Codafy reads the snapshot, tests the provider, and adds it only when the test succeeds.

The walkthrough video uses LRCLIB as an example because it provides a compatible public endpoint. You can follow the same process with any trusted provider whose snapshot matches Codafy’s source structure.

Import the source

  1. Copy the complete source snapshot or use a Copy Source button that provides the same JSON.

    Clipboard
    {
      "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"
    }
  2. Open Codafy > Settings > Lyrics.

  3. Select Import from Clipboard.

  4. Wait while Codafy tests the source automatically.

  5. When Added appears, select Done.

Copy a source snapshot, import it from the clipboard, and wait for Codafy to test and add it.

What Codafy accepts

The clipboard may contain either:

  1. One complete raw JSON object.
  2. A Base64-encoded version of that same object.

For raw JSON, copy only the object. Do not include Markdown code fences, introductory text, comments, or a trailing comma.

What happens during import

Codafy validates the snapshot and tests the endpoint automatically. The source is saved only when the test succeeds. A source with the same name, base URL, and endpoint cannot be added twice.

If Test failed — not added appears, see Troubleshooting lyrics sources.

Prepare your own snapshot

For the complete JSON structure and allowed values, see the Lyrics source snapshot reference.