Track Videos

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

Links video content to tracks for music video distribution across DSPs.

List track videos

GET

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

/track-videos

Retrieve video content associations with tracks

List track videos › 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

List track videos › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a track video

POST

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

/track-videos

Associate video content with a track

Create a track video › Request Body

object · required

Create a track video › Responses

Track video created successfully

object

object[]

Related resources included in the response

object

POST/track-videos

curl --request POST \
  --url https://api.idol.io/api/v2/track-videos \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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 video details

GET

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

/track-videos/{id}

Retrieve details for a specific track video by ID

Get track video details › path Parameters

id

string · required

Resource ID

Get track video details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a track video

PUT

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

/track-videos/{id}

Update an existing track video association

Update a track video › path Parameters

id

string · required

Resource ID

Update a track video › Request Body

object · required

Update a track video › Responses

Track video updated successfully

object

object[]

Related resources included in the response

object

PUT/track-videos/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/track-videos/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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

Delete a track video

DELETE

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

/track-videos/{id}

Remove video association from a track

Delete a track video › path Parameters

id

string · required

Resource ID

Delete a track video › Responses

Track video deleted successfully

No data returned

Asset Attachments Offers

Labelcamp API v2

Track Videos

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

Links video content to tracks for music video distribution across DSPs.

List track videos

GET

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

/track-videos

Retrieve video content associations with tracks

List track videos › 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

List track videos › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a track video

POST

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

/track-videos

Associate video content with a track

Create a track video › Request Body

object · required

Create a track video › Responses

Track video created successfully

object

object[]

Related resources included in the response

object

POST/track-videos

curl --request POST \
  --url https://api.idol.io/api/v2/track-videos \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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 video details

GET

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

/track-videos/{id}

Retrieve details for a specific track video by ID

Get track video details › path Parameters

id

string · required

Resource ID

Get track video details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a track video

PUT

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

/track-videos/{id}

Update an existing track video association

Update a track video › path Parameters

id

string · required

Resource ID

Update a track video › Request Body

object · required

Update a track video › Responses

Track video updated successfully

object

object[]

Related resources included in the response

object

PUT/track-videos/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/track-videos/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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": "track-videos",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "track": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "video": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "dsps": {
        "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

Delete a track video

DELETE

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

/track-videos/{id}

Remove video association from a track

Delete a track video › path Parameters

id

string · required

Resource ID

Delete a track video › Responses

Track video deleted successfully

No data returned

Asset Attachments Offers