Navigation :
Instrument
GET /v1/entities/instrument/{entity_id}
Retrieves a specific instrument.
Request Parameters
Location |
Parameter |
Type |
Required/ Optional |
Description |
path |
entity_id |
string |
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.attributes |
object |
|
data.attributes.name |
string |
The string name of the instrument |
data.attributes.previews[].content_type |
string enum |
The content type of the previews, currently audio/mp3 . |
data.attributes.previews[].url |
string |
The string url of the instrument’s preview file |
data.attributes.tags |
array |
|
data.attributes.tags[].category |
object |
|
data.attributes.tags[].category.id |
string |
The string id of the category |
data.attributes.tags[].category.name |
string |
The string name of the category |
data.attributes.tags[].id |
string |
The string id of the tag |
data.attributes.tags[].name |
string |
The string name of the tag |
data.id |
string |
The string id of the instrument, to be used in the instrument_group field of an Instrument Group |
data.links |
object |
|
data.links.self |
string |
The URL of the instrument |
data.type |
string |
The type of data (entity_instrument in this case) |
links |
object |
|
links.self |
string |
The URL of this instrument |
Example Response
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Body
{
"data": {
"attributes": {
"name": "ESP - Lush",
"previews": [
{
"content_type": "audio/mp3",
"url": "https://public-cdn.ampermusic.com/instruments/previews/dreamy_electric_guitar_v2.mp3"
}
],
"tags": [
{
"category": {
"id": "instrument_category",
"name": "Instrument Category"
},
"id": "string",
"name": "Strings"
},
{
"category": {
"id": "instrument_type",
"name": "Instrument Type"
},
"id": "pick_guitar",
"name": "Pick Guitars"
}
]
},
"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"
}
}