Tracks

Endpointhttps://api.idol.io/api/v2

Individual track management.

Adding artist roles: In addition to the standard artist attribute, you can add any available role from the Artist Roles endpoint into the input attribute, using the same syntax as the artist attribute.

List tracks

GET

https://api.idol.io/api/v2

/tracks

Retrieve a paginated list of tracks

List tracks › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

sort

string

Comma-separated list of fields to sort by (prefix with - for descending)

filter[distributor-id]

string

Filter by distributor ID

filter[company-ids]

string

Comma-separated company IDs

filter[label-ids]

string

Comma-separated label IDs

filter[product-id]

string

Filter by product ID

filter[volume-number]

integer

Filter by volume number

filter[track-number]

integer

Filter by track number

List tracks › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a track

POST

https://api.idol.io/api/v2

/tracks

Create a new track

Create a track › Request Body

object · required

Create a track › Responses

Track created successfully

object

object[]

Related resources included in the response

object

POST/tracks

curl --request POST \
  --url https://api.idol.io/api/v2/tracks \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "tracks",
    "id": "id",
    "attributes": {
      "title": "title",
      "subtitle": "subtitle",
      "track-number": 0,
      "volume-number": 1,
      "isrc-code": "isrc-code",
      "dolby-atmos-isrc": "dolby-atmos-isrc",
      "work": "work",
      "production-date": "2024-08-25T15:00:00Z",
      "iswc-code": "iswc-code",
      "production-line": "production-line",
      "recording-place": "recording-place",
      "is-hidden": true,
      "is-digital-exclusivity": true,
      "original-id": "original-id",
      "is-video": true,
      "clean": true,
      "parental-advisory": true,
      "explicit-content": true,
      "preview-start": 0,
      "preview-end": 0,
      "preview-url": "https://www.example.com/path/to/resource",
      "lyrics": "lyrics",
      "ttml-lyrics-url": "https://www.example.com/path/to/resource",
      "artist": [
        "string"
      ],
      "publisher": [
        "string"
      ],
      "length": 0,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "audio-language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featurings": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "publishers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "lyricists": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "track-videos": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "tracks",
    "id": "id",
    "attributes": {
      "title": "title",
      "subtitle": "subtitle",
      "track-number": 0,
      "volume-number": 1,
      "isrc-code": "isrc-code",
      "dolby-atmos-isrc": "dolby-atmos-isrc",
      "work": "work",
      "production-date": "2024-08-25T15:00:00Z",
      "iswc-code": "iswc-code",
      "production-line": "production-line",
      "recording-place": "recording-place",
      "is-hidden": true,
      "is-digital-exclusivity": true,
      "original-id": "original-id",
      "is-video": true,
      "clean": true,
      "parental-advisory": true,
      "explicit-content": true,
      "preview-start": 0,
      "preview-end": 0,
      "preview-url": "https://www.example.com/path/to/resource",
      "lyrics": "lyrics",
      "ttml-lyrics-url": "https://www.example.com/path/to/resource",
      "artist": [
        "string"
      ],
      "publisher": [
        "string"
      ],
      "length": 0,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "audio-language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featurings": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "publishers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "lyricists": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "track-videos": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get track details

GET

https://api.idol.io/api/v2

/tracks/{id}

Retrieve a single track by ID

Get track details › path Parameters

id

string · required

Resource ID

Get track details › query Parameters

include

string

Comma-separated list of related resources to include

Get track details › Responses

Successful response

object

object[]

Related resources included in the response

object

Delete a track

DELETE

https://api.idol.io/api/v2

/tracks/{id}

Delete a track

Delete a track › path Parameters

id

string · required

Resource ID

Delete a track › Responses

Track deleted successfully

No data returned

Update a track

PATCH

https://api.idol.io/api/v2

/tracks/{id}

Update an existing track

Update a track › path Parameters

id

string · required

Resource ID

Update a track › Request Body

object · required

Update a track › Responses

Track updated successfully

object

object[]

Related resources included in the response

object

PATCH/tracks/{id}

curl --request PATCH \
  --url https://api.idol.io/api/v2/tracks/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "tracks",
    "id": "id",
    "attributes": {
      "title": "title",
      "subtitle": "subtitle",
      "track-number": 0,
      "volume-number": 1,
      "isrc-code": "isrc-code",
      "dolby-atmos-isrc": "dolby-atmos-isrc",
      "work": "work",
      "production-date": "2024-08-25T15:00:00Z",
      "iswc-code": "iswc-code",
      "production-line": "production-line",
      "recording-place": "recording-place",
      "is-hidden": true,
      "is-digital-exclusivity": true,
      "original-id": "original-id",
      "is-video": true,
      "clean": true,
      "parental-advisory": true,
      "explicit-content": true,
      "preview-start": 0,
      "preview-end": 0,
      "preview-url": "https://www.example.com/path/to/resource",
      "lyrics": "lyrics",
      "ttml-lyrics-url": "https://www.example.com/path/to/resource",
      "artist": [
        "string"
      ],
      "publisher": [
        "string"
      ],
      "length": 0,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "audio-language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featurings": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "publishers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "lyricists": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "track-videos": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "tracks",
    "id": "id",
    "attributes": {
      "title": "title",
      "subtitle": "subtitle",
      "track-number": 0,
      "volume-number": 1,
      "isrc-code": "isrc-code",
      "dolby-atmos-isrc": "dolby-atmos-isrc",
      "work": "work",
      "production-date": "2024-08-25T15:00:00Z",
      "iswc-code": "iswc-code",
      "production-line": "production-line",
      "recording-place": "recording-place",
      "is-hidden": true,
      "is-digital-exclusivity": true,
      "original-id": "original-id",
      "is-video": true,
      "clean": true,
      "parental-advisory": true,
      "explicit-content": true,
      "preview-start": 0,
      "preview-end": 0,
      "preview-url": "https://www.example.com/path/to/resource",
      "lyrics": "lyrics",
      "ttml-lyrics-url": "https://www.example.com/path/to/resource",
      "artist": [
        "string"
      ],
      "publisher": [
        "string"
      ],
      "length": 0,
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "product": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "label": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "audio-language": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "performers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "authors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "composers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "contributors": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "remixers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "featurings": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "publishers": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "lyricists": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "track-videos": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Generate ISRC code

GET

https://api.idol.io/api/v2

/tracks/generate_isrc

Generate a new ISRC code from the distributor's range

Generate ISRC code › query Parameters

distributor_id

string · required

Generate ISRC code › Responses

ISRC generated successfully

isrc-code

string

Clone a track to a product

PUT

https://api.idol.io/api/v2

/tracks/{id}/clone

Clone an existing track and add it to a target product. This creates a copy of the track's metadata and associates it with the specified product at the given volume number.

Useful when distributing the same recording across multiple products (e.g. adding a single to a compilation album) without re-entering all track metadata.

Clone a track to a product › path Parameters

id

string · required

Resource ID

Clone a track to a product › Request Body

product_id

string · required

ID of the destination product where the track will be added

Example: 42

track_id

string · required

ID of the source track to clone

Example: 123

volume_number

integer · required

Volume number in the destination product (use 1 for single-disc products)

Example: 1

Clone a track to a product › Responses

Track cloned successfully

object

object[]

Related resources included in the response

object

Products Videos

List tracks

GET

https://api.idol.io/api/v2

/tracks

Retrieve a paginated list of tracks

List tracks › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

sort

string

Comma-separated list of fields to sort by (prefix with - for descending)

filter[distributor-id]

string

Filter by distributor ID

filter[company-ids]

string

Comma-separated company IDs

filter[label-ids]

string

Comma-separated label IDs

filter[product-id]

string

Filter by product ID

filter[volume-number]

integer

Filter by volume number

filter[track-number]

integer

Filter by track number

List tracks › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Get track details

GET

https://api.idol.io/api/v2

/tracks/{id}

Retrieve a single track by ID

Get track details › path Parameters

id

string · required

Resource ID

Get track details › query Parameters

include

string

Comma-separated list of related resources to include

Get track details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a track

PATCH

https://api.idol.io/api/v2

/tracks/{id}

Update an existing track

Update a track › path Parameters

id

string · required

Resource ID

Update a track › Request Body

object · required

Update a track › Responses

Track updated successfully

object

object[]

Related resources included in the response

object

Clone a track to a product

PUT

https://api.idol.io/api/v2

/tracks/{id}/clone

Clone an existing track and add it to a target product. This creates a copy of the track's metadata and associates it with the specified product at the given volume number.

Useful when distributing the same recording across multiple products (e.g. adding a single to a compilation album) without re-entering all track metadata.

Clone a track to a product › path Parameters

id

string · required

Resource ID

Clone a track to a product › Request Body

product_id

string · required

ID of the destination product where the track will be added

Example: 42

track_id

string · required

ID of the source track to clone

Example: 123

volume_number

integer · required

Volume number in the destination product (use 1 for single-disc products)

Example: 1

Clone a track to a product › Responses

Track cloned successfully

object

object[]

Related resources included in the response

object