Labelcamp API v2

Import Tasks

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

Audio file uploads and processing tasks

List import tasks

GET

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

/import-tasks

Retrieve a list of import tasks with optional filtering by product or distributor.

List import tasks › query Parameters

filter[product-id]

string

Filter by product ID

filter[distributor-id]

string

Filter by distributor ID

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 import tasks › Responses

List of import tasks

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

GET/import-tasks

curl --request GET \
  --url https://api.idol.io/api/v2/import-tasks

shell

Example Responses

{
  "data": [
    {
      "type": "import-tasks",
      "id": "1",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "precision": 24,
        "master-type": "hd",
        "status": "uploaded",
        "url": "https://secure-url.example.com/file.wav",
        "md5": "5d41402abc4b2a76b9719d911017c592"
      },
      "relationships": {
        "attachable": {
          "data": {
            "type": "tracks",
            "id": "123"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 1,
      "count": 1
    }
  }
}

json

application/vnd.api+json

Create an import task

POST

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

/import-tasks

Create a new import task to retrieve and process audio/video files or artwork.

What happens when you create an ImportTask:

Creating an upload ImportTask launches a job that will:

Retrieve the file stored on the url provided
Check the md5 checksum if present
Create a record associated to the track if provided
Update the associated video if it exists
Change the status of the import-task to completed

Create an import task › Request Body

object · required

Create an import task › Responses

Import task created successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/import-tasks

curl --request POST \
  --url https://api.idol.io/api/v2/import-tasks \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "import-tasks",
    "attributes": {
      "master-type": "hd",
      "precision": 24,
      "status": "uploaded",
      "url": "https://secure-url.example.com/track.wav",
      "md5": "5d41402abc4b2a76b9719d911017c592"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "import-tasks",
    "attributes": {
      "master-type": "hd",
      "precision": 24,
      "status": "uploaded",
      "url": "https://secure-url.example.com/track.wav",
      "md5": "5d41402abc4b2a76b9719d911017c592"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get a specific import task

GET

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

/import-tasks/{id}

Retrieve a single import task by its ID.

Get a specific import task › path Parameters

id

string · required

The import task ID

Get a specific import task › Responses

A single import task

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/import-tasks/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/import-tasks/:id

shell

Example Responses

{
  "data": {
    "type": "import-tasks",
    "id": "1",
    "attributes": {
      "created-at": "2023-01-15T10:00:00Z",
      "updated-at": "2023-01-15T10:00:00Z",
      "precision": 24,
      "master-type": "dolby_atmos",
      "status": "uploaded",
      "url": "https://secure-url.example.com/atmos-file.atmos",
      "md5": "5d41402abc4b2a76b9719d911017c592"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Artist Roles Send Tasks

Labelcamp API v2

Import Tasks

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

Audio file uploads and processing tasks

List import tasks

GET

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

/import-tasks

Retrieve a list of import tasks with optional filtering by product or distributor.

List import tasks › query Parameters

filter[product-id]

string

Filter by product ID

filter[distributor-id]

string

Filter by distributor ID

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 import tasks › Responses

List of import tasks

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

GET/import-tasks

curl --request GET \
  --url https://api.idol.io/api/v2/import-tasks

shell

Example Responses

{
  "data": [
    {
      "type": "import-tasks",
      "id": "1",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "precision": 24,
        "master-type": "hd",
        "status": "uploaded",
        "url": "https://secure-url.example.com/file.wav",
        "md5": "5d41402abc4b2a76b9719d911017c592"
      },
      "relationships": {
        "attachable": {
          "data": {
            "type": "tracks",
            "id": "123"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 1,
      "count": 1
    }
  }
}

json

application/vnd.api+json

Create an import task

POST

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

/import-tasks

Create a new import task to retrieve and process audio/video files or artwork.

What happens when you create an ImportTask:

Creating an upload ImportTask launches a job that will:

Retrieve the file stored on the url provided
Check the md5 checksum if present
Create a record associated to the track if provided
Update the associated video if it exists
Change the status of the import-task to completed

Create an import task › Request Body

object · required

Create an import task › Responses

Import task created successfully

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

POST/import-tasks

curl --request POST \
  --url https://api.idol.io/api/v2/import-tasks \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "import-tasks",
    "attributes": {
      "master-type": "hd",
      "precision": 24,
      "status": "uploaded",
      "url": "https://secure-url.example.com/track.wav",
      "md5": "5d41402abc4b2a76b9719d911017c592"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "import-tasks",
    "attributes": {
      "master-type": "hd",
      "precision": 24,
      "status": "uploaded",
      "url": "https://secure-url.example.com/track.wav",
      "md5": "5d41402abc4b2a76b9719d911017c592"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get a specific import task

GET

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

/import-tasks/{id}

Retrieve a single import task by its ID.

Get a specific import task › path Parameters

id

string · required

The import task ID

Get a specific import task › Responses

A single import task

object

The primary resource object (override with specific resource schema)

object[]

Related resources included in the response

object

GET/import-tasks/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/import-tasks/:id

shell

Example Responses

{
  "data": {
    "type": "import-tasks",
    "id": "1",
    "attributes": {
      "created-at": "2023-01-15T10:00:00Z",
      "updated-at": "2023-01-15T10:00:00Z",
      "precision": 24,
      "master-type": "dolby_atmos",
      "status": "uploaded",
      "url": "https://secure-url.example.com/atmos-file.atmos",
      "md5": "5d41402abc4b2a76b9719d911017c592"
    },
    "relationships": {
      "attachable": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Artist Roles Send Tasks