⚛️Entity

An entity refers to an action that you are trying to perform. For example, when trying to convert a track, the entity in this case would be track.

The entities currently supported are:

• Track

• Playlist

When you convert a playlist, you have to pass a target_platform body and specify the platform you want the result fetched for and response you get is a task id.

It is important to note that unlike playlist conversion, track conversion returns the result immediately and you are not polling a task id.

The platforms supported for track entities are

• Apple Music

• Spotify

• Deezer

• TIDAL

• Youtube Music

The Platforms currently supported for playlists entites are

• Apple Music

• Spotify

• Deezer

• TIDAL

Here, you can find a list of the value you pass in place of the platform in your requests.

Playlist results may return incomplete number of results for the target platform. When you convert a playlist and a platform result does not match the number of results in the source platform, you get the omitted tracks as part of the results.

Create a new track conversion

POST https://api.orchdio.dev/v1/entity/convert

Creates a new pet.

Headers

Name	Type	Description
x-orchdio-public-key*	String	Your app's public key
content-type		JSON Content type

Request Body

Name	Type	Description
url*	string	The url of the track

200 Pet successfully created

{
   "data":{
      "payload":{
         "entity":"track",
         "platforms":{
            "deezer":{
               "url":"https://www.deezer.com/track/122240910",
               "artists":[
                  "BROCKHAMPTON"
               ],
               "released":"",
               "duration":"2:20",
               "duration_milli":140000,
               "explicit":true,
               "title":"BEN CARSON",
               "preview":"https://cdns-preview-0.dzcdn.net/stream/c-0bbb9e389f1be631711d73ec325672fc-4.mp3",
               "album":"ALL-AMERICAN TRASH",
               "id":"122240910",
               "cover":"https://api.deezer.com/album/12786592/image"
            },
            "spotify":{
               "url":"https://open.spotify.com/track/253490LtmZhYGUQy05eCNV",
               "artists":[
                  "BROCKHAMPTON"
               ],
               "released":"2016-04-11",
               "duration":"2:20",
               "duration_milli":140930,
               "explicit":true,
               "title":"BEN CARSON",
               "preview":"https://p.scdn.co/mp3-preview/bafd67be4714163bef2b36b6a62df2f545912b69?cid=8d367c0bbfe142d494bcbf1cf2e30f06",
               "album":"ALL-AMERICAN TRASH",
               "id":"253490LtmZhYGUQy05eCNV",
               "cover":"https://i.scdn.co/image/ab67616d0000b27346fc3effbd1b9af4c69019ac"
            },
            "tidal":{
               "url":"http://www.tidal.com/track/59039332",
               "artists":[
                  "BROCKHAMPTON"
               ],
               "released":"2016-04-11T00:00:00.000+0000",
               "duration":"2:20",
               "duration_milli":140000,
               "explicit":true,
               "title":"BEN CARSON",
               "preview":"",
               "album":"ALL-AMERICAN TRASH",
               "id":"59039332",
               "cover":"https://resources.tidal.com/images/f3b85b83/abe8/429f/b690/ac91f107801a/320x320.jpg"
            },
            "ytmusic":{
               "url":"https://music.youtube.com/watch?v=SvK8kFPGozk",
               "artists":[
                  "BROCKHAMPTON"
               ],
               "released":"",
               "duration":"2:20",
               "duration_milli":140000,
               "explicit":true,
               "title":"BEN CARSON",
               "preview":"https://music.youtube.com/watch?v=SvK8kFPGozk",
               "album":"ALL-AMERICAN TRASH",
               "id":"SvK8kFPGozk",
               "cover":"https://lh3.googleusercontent.com/iXEWdTPKFPcTUrnMMJOF5ldqNFvWDT_xohinFfMOpiTKWlg_C_4KcI_Uw3EDOohSl7mWIi9EXLposZTv=w60-h60-l90-rj"
            },
            "applemusic":{
               "url":"https://music.apple.com/us/album/ben-carson/1099993677?i=1099993849",
               "artists":[
                  "BROCKHAMPTON"
               ],
               "released":"2016-04-11",
               "duration":"2:20",
               "duration_milli":140931,
               "explicit":false,
               "title":"Ben Carson",
               "preview":"https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview125/v4/b0/51/5b/b0515b82-e3c7-2295-6d90-c6c38e4c7006/mzaf_9934193650536463715.plus.aac.p.m4a",
               "album":"All-American Trash",
               "id":"1099993849",
               "cover":"https://is5-ssl.mzstatic.com/image/thumb/Music49/v4/4f/3d/f9/4f3df9dd-befb-4d4e-f59f-49d2db4d4d16/638339446406_cover.jpg/150x150bb.jpg"
            }
         },
         "short_url":"2NuMHDstM"
      }
   },
   "message":"Request Ok",
   "status":200
}

401 Permission denied

500: Internal Server Error

{
	"error": "Internal error"
	"message": "an internal server error occured",
	"status": 500
}

Updating a pet