☰
Navigation :

Instrument

GET /v1/entities/instrument/{entity_id}

Retrieves a specific instrument.

Request Parameters

Location Parameter Type Required/ Optional Description
path entity_id number optional The string id of the instrument being searched for

Example Request

GET /v1/entities/instrument/dreamy_electric_guitar HTTP/1.1
Host: api.ampermusic.com
Content-Type: application/vnd.api+json
Authorization: Basic abcxyz

Response Data

Data Item Type Description
data object
data.type string The type of data (entity_instrument in this case)
data.id string The string ID of the instrument
data.attributes object
data.attributes.name string The string name of the instrument
data.attributes.preview array
data.attributes.preview[].url string The string url of the instrument’s preview file
data.attributes.preview[].content_type string enum The content type of the preview. Of the following values:
• audio/mp3
• audio/ogg
data.attributes.tags array
data.attributes.tags[].id string The string id of the tag
data.attributes.tags[].name string The string name of the tag
data.attributes.tags[].category string The string category of the tag
data.links object
data.links.self string The URL of the instrument
links object
links.self string The URL of this instrument

Example Response

Header

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

Body

{
	"data": {
		"attributes": {
			"name": "Dreamy El Guitar",
			"preview": [
				{
					"content_type": "audio/mp3",
					"url": "<some_url>"
				},
				{
					"content_type": "audio/ogg",
					"url": "<some_url>"
				}
			],
			"tags": [
				{
					"category": "instrument_category",
					"id": "guitar",
					"name": "Guitar"
				},
				{
					"category": "instrument_type",
					"id": "electric_guitar",
					"name": "Electric Guitar"
				}
			]
		},
		"id": "dreamy_electric_guitar",
		"links": {
			"self": "https://api.ampermusic.com/v1/entities/instrument/dreamy_electric_guitar"
		},
		"type": "entity_instrument"
	},
	"links": {
		"self": "https://api.ampermusic.com/v1/entities/instrument/dreamy_electric_guitar"
	}
}