Lyrics

Generated lyrics operations.

PUT/v1/lyrics/providerSave lyrics provideradmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: put_lyrics_provider
Max body: 2 MiB

Request body application/json · required

Example

{
  "enabled": true,
  "expectedRevision": 0
}

Schema

enabledbooleanrequired
expectedRevisionintegerrequired

Responses

200Successapplication/json

Example

{
  "configured": true,
  "lrclib": true,
  "revision": 0
}

Schema

configuredbooleanrequired
lrclibbooleanrequired
revisionintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X PUT "http://127.0.0.1:32500/v1/lyrics/provider" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"expectedRevision":0}'