Video

List Videos

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

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": [
    {
      "id": "<ID>",
      "type": "videos",
      "links": {
        "self": "https://api.idol.io/api/v2/videos/<ID>"
      },
      "attributes": {
        "created-at": "2023-11-18T16:45:54.074+01:00",
        "updated-at": "2024-09-13T08:26:46.651+02:00",
        "name": "Test",
        "isrc-audio": "",
        "isrc-video": "",
        "upc-code": "",
        "crop": {
          "top": "0",
          "left": "0",
          "right": "0",
          "bottom": "0"
        },
        "length": 202,
        "resolution": "720x544",
        "cover-url": "https://assets.idol.io/<ID>/<ID>/<ID>/video/<ID>_thumb.jpg?1447861553",
        "movie-size": 7302950836,
        "is-youtube": false
      },
      "relationships": {
        "label": {
          "links": {
            "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/label",
            "related": "https://api.idol.io/api/v2/videos/<ID>/label"
          },
          "data": {
            "type": "labels",
            "id": "<ID>"
          }
        },
        "tracks": {
          "links": {
            "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/tracks",
            "related": "https://api.idol.io/api/v2/videos/<ID>/tracks"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "videos",
      "links": {
        "self": "https://api.idol.io/api/v2/videos/<ID>"
      },
      "attributes": {
        "created-at": "2020-11-18T17:59:59.458+01:00",
        "updated-at": "2021-09-13T08:27:02.342+02:00",
        "name": "Test 10s",
        "isrc-audio": "",
        "upc-code": "",
        "crop": {
          "top": "0",
          "left": "0",
          "right": "0",
          "bottom": "0"
        },
        "length": 0,
        "resolution": "720x544",
        "cover-url": "https://assets.idol.io/<ID>/<ID>/<ID>/video/<ID>_thumb.jpg?1447865997",
        "movie-size": 7302950836,
        "is-youtube": true
      },
      "relationships": {
        "label": {
          "links": {
            "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/label",
            "related": "https://api.idol.io/api/v2/videos/<ID>/label"
          },
          "data": {
            "type": "labels",
            "id": "<ID>"
          }
        },
        "tracks": {
          "links": {
            "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/tracks",
            "related": "https://api.idol.io/api/v2/videos/<ID>/tracks"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "videos",
      "links": {
        "self": "https://api.idol.io/api/v2/videos/<ID>"
      },
      "attributes": {
        "created-at": "2022-01-29T15:10:18.322+01:00",
        "updated-at": "2023-09-13T08:27:02.932+02:00",
        "name": "Test Asset",
        "isrc-audio": "",
        "upc-code": "",
        "crop": {
          "top": "0",
          "left": "0",
          "right": "0",
          "bottom": "0"
        },
        "length": 202,
        "resolution": "720x544",
        "cover-url": "https://assets.idol.io/<ID>/<ID>/<ID>/video/<ID>_thumb.jpg?1454076617",
        "movie-size": 7302950836,
        "is-youtube": false
      },
      "relationships": {
        "label": {
          "links": {
            "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/label",
            "related": "https://api.idol.io/api/v2/videos/<ID>/label"
          },
          "data": {
            "type": "labels",
            "id": "<ID>"
          }
        },
        "tracks": {
          "links": {
            "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/tracks",
            "related": "https://api.idol.io/api/v2/videos/<ID>/tracks"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 17,
    "page-count": 6
  },
  "links": {
    "first": "https://api.idol.io/api/v2/videos?page%5Bnumber%5D=1&page%5Bsize%5D=3",
    "next": "https://api.idol.io/api/v2/videos?page%5Bnumber%5D=2&page%5Bsize%5D=3",
    "last": "https://api.idol.io/api/v2/videos?page%5Bnumber%5D=6&page%5Bsize%5D=3"
  }
}

Filter resources

Distributor

api/v2/videos?filter[distributor-id]=1

Companies

api/v2/videos?filter[company-ids]=1,2

Labels

api/v2/videos?filter[label-ids]=1,2

Products

api/v2/videos?filter[product-ids]=1,2

Tracks

api/v2/videos?filter[track-ids]=1,2

ProductSubgenres

api/v2/videos?filter[dstributor-product-subgenre-ids]=1,2

ProductGenres

api/v2/videos?filter[product-genre-ids]=1,2

Get Video

GET https://api.idol.io/api/v2/videos/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Record

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": {
    "id": "<ID>",
    "type": "videos",
    "links": {
      "self": "https://api.idol.io/api/v2/videos/<ID>"
    },
    "attributes": {
      "created-at": "2023-11-18T16:45:54.074+01:00",
      "updated-at": "2024-09-13T08:26:46.651+02:00",
      "name": "Test Asset Two",
      "isrc-audio": "",
      "isrc-video": "",
      "upc-code": "",
      "crop": {
        "top": "0",
        "left": "0",
        "right": "0",
        "bottom": "0"
      },
      "length": 202,
      "resolution": "720x544",
      "cover-url": "https://assets.idol.io/<ID>/<ID>/<ID>/video/<ID>_thumb.jpg?1447861553",
      "movie-size": 7302950836,
      "is-youtube": false
    },
    "relationships": {
      "label": {
        "links": {
          "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/label",
          "related": "https://api.idol.io/api/v2/videos/<ID>/label"
        },
        "data": {
          "type": "labels",
          "id": "<ID>"
        }
      },
      "tracks": {
        "links": {
          "self": "https://api.idol.io/api/v2/videos/<ID>/relationships/tracks",
          "related": "https://api.idol.io/api/v2/videos/<ID>/tracks"
        }
      }
    }
  }
}

Create Video

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

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
crop	object	{ "top": "100", "bottom":"100", "left":"100", "right":"100" }
label*	object	Label Object
tracks*	object	TrackObject
name*	string	Video name
isrc-audio	string	US1239485723
isrc-video	object	US827384958
upc-code	object	872843958473
front-cover	string	Base64 - e.g. data:image/jpg;base64,JsqWlWh...
front-cover-md5	string	e2cf9dfacc282c31c8cc296..

200

{
  "data": {
    "id": "<ID>",
    "type": "videos",
    "links": {
        "self": "https://api.idol.io/api/v2/videos/<ID>"
    },
    "attributes": {
        "created-at"=>"2023-07-08T15:23:35.465+02:00",
        "updated-at"=>"2023-07-08T15:23:35.465+02:00",
        "name"=>"My Summer Holidays",
        "isrc-audio"=>"AEA020900003",
        "isrc-video": "VEA020900003",
        "upc-code"=>"5054260749252",
        "crop"=>{"top"=>"0", "left"=>"0", "right"=>"0", "bottom"=>"0"},
        "length"=>0,
        "resolution"=>nil,
        "cover-url"=>"<url>",
        "reference"=>true,
        "is-youtube"=>false
    },
    "relationships": {
        "label"=>{
            "links"=>{
                "self"=>"https://api.idol.io/api/v2/videos/<ID>/relationships/label",
                "related"=>"https://api.idol.io/api/v2/videos/<ID>/label"
            },
        "data"=>{
            "type"=>"labels",
            "id"=>"<label id>"
            }
        },
        "tracks"=>{
            "links"=>{
            "self"=>"https://api.idol.io/api/v2/videos/<ID>/relationships/tracks",
            "related"=>"https://api.idol.io/api/v2/videos/<ID>/tracks"
            }
        }
    }
  }
}

MD5 check

By setting the front-cover-md5 attribute, you will request a file checksum on the server to ensure the checksum is the same after upload. If the checksum differs, the create/update will be rejected. If the value is null, the checksum will not be performed.

Update Video

PUT https://api.idol.io/api/v2/videos/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Video

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
crop	object	{ "top": "100", "bottom":"100", "left":"100", "right":"100" }
label*	object	Label Object
tracks*	object	TrackObject
name*	string	Video name
isrc-audio	string	US1239485723
isrc-video	object	US827384958
upc-code	object	872843958473
front-cover	string	Base64 - e.g. data:image/jpg;base64,JsqWlWh...
front-cover-md5	string	e2cf9dfacc282c31c8cc296..

200

{
  "data": {
    "id": "<ID>",
    "type": "videos",
    "links": {
        "self": "https://api.idol.io/api/v2/videos/<ID>"
    },
    "attributes": {
        "created-at"=>"2023-07-08T15:23:35.465+02:00",
        "updated-at"=>"2023-07-08T15:23:35.465+02:00",
        "name"=>"My Summer Holidays",
        "isrc-audio"=>"AEA020900003",
        "isrc-video": "VEA020900003",
        "upc-code"=>"5054260749252",
        "crop"=>{"top"=>"0", "left"=>"0", "right"=>"0", "bottom"=>"0"},
        "length"=>0,
        "resolution"=>nil,
        "cover-url"=>"<url>",
        "reference"=>true,
        "is-youtube"=>false,
    },
    "relationships": {
        "label"=>{
            "links"=>{
                "self"=>"https://api.idol.io/api/v2/videos/<ID>/relationships/label",
                "related"=>"https://api.idol.io/api/v2/videos/<ID>/label"
            },
        "data"=>{
            "type"=>"labels",
            "id"=>"<label id>"
            }
        },
        "tracks"=>{
            "links"=>{
            "self"=>"https://api.idol.io/api/v2/videos/<ID>/relationships/tracks",
            "related"=>"https://api.idol.io/api/v2/videos/<ID>/tracks"
            }
        }
    }
  }
}

MD5 check

By setting the front-cover-md5 attribute, you will request a file checksum on the server to ensure the checksum is the same after upload. If the checksum differs, the create/update will be rejected. If the value is null, the checksum will not be performed.

Delete a video

DELETE https::/api.idol/io/api/v2/videos/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Record

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json