☰
Navigation :

List of Descriptors

GET /v1/entities/descriptor

Retrieves a list of descriptors.

Request Parameters

Location Parameter Type Required/ Optional Description
query offset number optional The numeric offset of the first record to return. May be a value between 1 and 1000 inclusive
query cursor string optional The cursor ID of the first record to return. Example: driving_classic_rock
query limit number optional The number of records to return. May be a value between 1 and 100 inclusive. If a value is not specified, the default is 10
query id string optional Filter. Will match to records whose id contains the given string
query name string optional Filter. Will match to records whose name contains the given string
query min_tempo number optional Filter. Will match to records whose min_tempo matches the given integer
query max_tempo number optional Filter. Will match to records whose max_tempo matches the given integer
query instruments.id string optional Filter. Will match to records that possess an instrument whose id contains the given string
query instruments.name string optional Filter. Will match to records that possess an instrument whose name contains the given string
query tags.id string optional Filter. Will match to records that possess a tag whose id contains the given string
query tags.name string optional Filter. Will match to records that possess a tag whose name contains the given string
query tags.category string optional Filter. Will match to records that possess a tag whose category contains the given string

For a description of how to use these query parameters, see Pagination.

Example Request

GET /v1/entities/descriptor?offset=0&limit=1 HTTP/1.1
Host: api.ampermusic.com
Content-Type: application/vnd.api+json
Authorization: Basic abcxyz

Response Data

Data Item Type Description
data array
data[].type string The type of data (entity_descriptor in this case)
data[].id string The string ID of the descriptor
data[].attributes object
data[].attributes.name string The string name of the descriptor
data[].attributes.min_tempo number The minimum beats per minute of the descriptor
data[].attributes.max_tempo number The maximum beats per minute of the descriptor
data[].attributes.constraints array
data[].attributes.constraints[].cap number The number of instruments of this tag allowed in the descriptor
data[].attributes.constraints[].tags array Array of size one
data[].attributes.constraints[].tags[].id string The id of the tag
data[].attributes.constraints[].tags[].name string The name of the tag
data[].attributes.constraints[].tags[].category string The category of the tag
data[].attributes.instruments array
data[].attributes.instruments[].id string The string id of the instrument
data[].attributes.instruments[].name string The string name of the instrument
data[].attributes.preview array
data[].attributes.preview[].url string The string url of the descriptor’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 descriptor
links object
links.self string The URL of this list of descriptors
links.first string The URL of the first (or possibly only) page of results. It is always available
links.prev string The URL of the previous page of results when using offset/limit mode. It is omitted if there is no previous page and is not available in cursor/limit mode
links.next string The URL of the next page of results when using offset/limit mode. It is omitted if there are no additional pages and is available on the first page, and on any subsequent page, accessed with offset/limit mode
links.next_cursor string The URL of the next page of results when using cursor/limit mode. It is omitted if there are no additional pages and is available on the first page, and on any subsequent page, accessed with cursor/limit mode

Example Response

Header

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

Body

{
	"data": [
		{
			"attributes": {
				"constraints": [
					{
						"cap": 1,
						"tags": [
							{
								"category": "instrument_category",
								"id": "basses",
								"name": "Basses"
							}
						]
					},
					...
				],
				"instruments": [
					{
						"id": "classical_grand_piano",
						"name": "Classical 6ft Grant Piano"
					},
					...
				],
				"max_tempo": 165,
				"min_tempo": 130,
				"name": "Driving Classic Rock",
				"preview": [
					{
						"content_type": "audio/mp3",
						"url": "<some_url>"
					},
					{
						"content_type": "audio/ogg",
						"url": "<some_url>"
					}
				],
				"tags": [
					{
						"category": "mood",
						"id": "driving",
						"name": "Driving"
					},
					...
				]
			},
			"id": "driving_classic_rock",
			"links": {
				"self": "https://api.ampermusic.com/v1/entities/descriptor/driving_classic_rock"
			},
			"type": "entity_descriptor"
		}
	],
	"links": {
		"first": "https://api.ampermusic.com/v1/entities/descriptor?limit=1",
		"next": "https://api.ampermusic.com/v1/entities/descriptor?offset=1&limit=1",
		"next_cursor": "https://api.ampermusic.com/v1/entities/descriptor?cursor=exciting_classic_rock&limit=1",
		"self": "https://api.ampermusic.com/v1/entities/descriptor?limit=1"
	}
}