Quick Start

A brief introduction to getting started with building using Orchdio APIs.

Create your Organization

In order to get started, head to https://dev.orchdio.com to create a new organization. After creating a new Organization.

Next, you need to create a new App and add your integration credentials. Your integration credentials are the API credentials created for you when you create a new application on the streaming platform you plan to support. For example, if you want to integrate Spotify, you need to create a Spotify app and you'd get integration credentials created. You must add at least one integration when you create a new Orchdio App.

Get your API keys

After creating a new app, API keys are generated for you, which you can copy and use in your requests.

Make your first request

Now that you've gotten your keys, you can make a request to the convert endpoint. In order to make read-only calls (i.e you're requesting for a resource, not trying to perform, say a user action), you need to pass the public key for your app (from the dashboard)

Convert track.

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

Converts a new track by fetching the links to the track from other platforms.

Headers

Name	Type	Description
x-orchdio-public-key*	String	the public key associated with an app

Request Body

Name	Type	Description
url*	string	the url to convert

200 Track converted

{
	"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
}jsp

401: Unauthorized Permission denied

400: Bad Request Bad request. Invalid body

{
    // Response
}

500: Internal Server Error Internal Error

{
    // Response
}

You can also convert a playlist as so:

Convert a playlist

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

Headers

Name	Type	Description
x-orchdio-public-key*	String

Request Body

Name	Type	Description
url*	String
target_platform*	String

200: OK

{
	"data": {
		"task_id": "af2f9670-196e-47ed-93b0-afe8b0955e53",
		"payload": null,
		"status": "pending"
	},
	"message": "Request Ok",
	"status": 200
}

400: Bad Request

{
    "error": "Bad request in body",
    "message": "Target platform not passed",
    "status": 400
}

401: Unauthorized

Invalid key

500: Internal Server Error

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

The important to note is that if you're converting a playlist, you'll get a task id as response which you would poll to get the final result of the conversion. You also have to pass the target_platform in the request body. You can find the values here.