OpenAPI spec
GET /openapi.json
The API publishes an OpenAPI 3.1 document at https://api.betterlyrics.org/openapi.json. Point a client generator, an API client or an agent at it. The parameter, field and header tables on these reference pages are built from the same document, so they match what the API actually does.
curl -o openapi.json https://api.betterlyrics.org/openapi.json
The response is cached for five minutes (Cache-Control: public, max-age=300).
Endpoints
| Method | Path | Summary |
|---|---|---|
| GET | /getLyrics | Get lyrics (default provider) |
| GET | /ttml/getLyrics | Get lyrics from the TTML provider |
| GET | /kugou/getLyrics | Get lyrics from the Kugou provider |
| GET | /qq/getLyrics | Get lyrics from the QQ provider |
| GET | /revalidate | Refresh cached lyrics |
| GET | /health | Service health |
| GET | /openapi.json | This OpenAPI document |
| GET | /cache | Removed full cache dump. Returns 410. |
| GET | /cache/help | Cache endpoint documentation |
| GET | /cache/lookup | Check whether a song is cached |
| GET | /cache/debug | Inspect one cache key |
| GET | /cache/keys | List and search cache keys |
| GET | /cache/clear | Clear all cached lyrics and negative entries |
| GET | /cache/clear/{provider} | Clear cached entries for one provider |
| GET | /cache/backup | Removed (backups are handled by the database platform). Returns 410. |
| GET | /cache/backups | Removed (backups are handled by the database platform). Returns 410. |
| GET | /cache/restore | Removed (backups are handled by the database platform). Returns 410. |
| GET | /cache/migrate | Removed (backups are handled by the database platform). Returns 410. |
| GET | /cache/migrate/status | Removed (backups are handled by the database platform). Returns 410. |
| GET | /cache/dump | Removed (backups are handled by the database platform). Returns 410. |