vmmusic docs

community lyrics contribution guide

Are you a verified artist? 🎤

Use our dedicated platform for official artist submissions.

Go to BASH

POST /api/publish

publish a new lyrics

note: this api is experimental and subject to potential changes in the future.

publish a new lyrics to lrclib database. this api can be called anonymously, and no registration is required.

if both plain lyrics and synchronized lyrics are left empty, the track will be marked as instrumental.

all previous revisions of the lyrics will still be kept when publishing lyrics for a track that already has existing lyrics.

obtaining the publish token

every post /api/publish request must include a fresh, valid publish token in the x-publish-token header.

to find a valid nonce, please refer to the source code of lrcget.

header name	required	description
X-Publish-Token	true	retrieved via solving a cryptographic challenge

request json body

{
  "trackName": "string",
  "artistName": "string",
  "albumName": "string",
  "duration": number,
  "plainLyrics": "string",
  "syncedLyrics": "string"
}

POST /api/request-challenge

request a challenge

generate a pair of prefix and target strings for the cryptographic challenge. each challenge has an expiration time of 5 minutes.

{
  "prefix": "VXMwW2qPfW2gkCNSl1i708NJkDghtAyU",
  "target": "000000FF00000000000000000000000000000000000000000000000000000000"
}