Skip to the content
  1. API reference
  2. Recommendations

Get a catalogue

GET/public/recommendations/catalogues/{catalogueId}
CoreAuthBasicTokenDevTokenDocsSession

The status and the coverage report of one catalogue. isrcs: the unique valid ISRCs. invalid: the lines that are not an ISRC. matched: the ISRCs we know. withVector: the matched ISRCs that can appear in results. coverage = withVector / isrcs. A matched track without a vector is still a valid seed.

Path parameters

catalogueId
stringrequired

The catalogue id from POST /public/recommendations/catalogues.

Response

200application/json · RecommendationCatalogueok
id
string
required
name
string
required
status
string
requiredOne of: awaitingUpload, processing, ready, failed
importing
boolean
requiredTrue while an import runs. A ready catalogue stays ready while a new file imports.
isrcs
number
requiredUnique valid ISRCs.
invalid
number
requiredLines of the last file that are not an ISRC.
matched
number
requiredISRCs we know.
withVector
number
requiredMatched ISRCs that can appear in results.
coverage
number
requiredwithVector / isrcs.
error
string | null
requiredWhy the last import failed: catalogue_limit, upload_missing, file_too_large or import_failed. After a failed new file of a ready catalogue, the status stays ready with the old data.
createdAt
date-time
required
updatedAt
date-time
required
Example answer
{
  "id": "42",
  "name": "Main catalogue",
  "status": "awaitingUpload",
  "importing": true,
  "isrcs": 120000,
  "invalid": 12,
  "matched": 101000,
  "withVector": 88000,
  "coverage": 0.7333,
  "error": "string",
  "createdAt": "2026-10-16T09:41:07.000Z",
  "updatedAt": "2026-10-16T09:41:07.000Z"
}

Errors

401

No valid credential.

404

catalogue_not_found: the catalogue does not exist or is not yours.

429

Your account sent more calls this minute than its rate limit allows.