Descriptor

GET /v1/entities/descriptor/{entity_id}

Retrieves a specific descriptor.

Request Parameters

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

Example Request

GET /v1/entities/descriptor/documentary_minimal_intriguing 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_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 recommended beats per minute of the descriptor
data.attributes.max_tempo number The maximum recommended 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 descriptor

Example Response

Header

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

Body

{
    "data": {
        "attributes": {
            "constraints": [
                {
                    "cap": 2,
                    "tags": [
                        {
                            "category": "instrument_category",
                            "id": "key",
                            "name": "Key"
                        }
                    ]
                },
                ...
            ],
            "instruments": [
                {
                    "id": "mallet",
                    "name": "Mallet"
                },
                ...
            ],
            "max_tempo": 120,
            "min_tempo": 100,
            "name": "Documentary Minimal Intriguing",
            "preview": [
                {
                    "content_type": "audio/mp3",
                    "url": "<some_url>"
                },
                {
                    "content_type": "audio/ogg",
                    "url": "<some_url>"
                }
            ],
            "tags": [
                {
                    "category": "mood",
                    "id": "intriguing",
                    "name": "Intriguing"
                },
                ...
            ]
        },
        "id": "documentary_minimal_intriguing",
        "links": {
            "self": "https://api.ampermusic.com/v1/entities/descriptor/documentary_minimal_intriguing"
        },
        "type": "entity_descriptor"
    },
    "links": {
        "self": "https://api.ampermusic.com/v1/entities/descriptor/documentary_minimal_intriguing"
    }
}