Skip to main content
GET
Get runs

Authorizations

x-api-key
string
header
required

Your Recoup API key. Learn more.

Query Parameters

kind
enum<string>
required

Required. The run type to list. Unknown kinds are rejected with 400.

Available options:
valuation,
music
limit
integer
default:1

Optional. Maximum runs to return, newest first. Defaults to 1 (the latest run).

Required range: 1 <= x <= 20

Response

The calling account's runs of the requested kind, newest first. Empty when the account has never run one.

The calling account's runs of the requested kind, newest first.

status
enum<string>

Status of the request

Available options:
success,
error
runs
(Valuation run · object | Music run · object)[]

Runs, newest first. Empty when the account has never run one of this kind. The item shape follows the requested kind.

One background run. id is opaque; state is a domain phase, not a storage value: queued (capture accepted, not yet scraping), measuring (capture in flight, or finished moments ago and being claimed), claimed (catalog materialized - result.catalog_id is set), failed (the capture finished but no catalog was claimed, or the capture itself failed).

error
string

Error message (only present if status is 'error')