☰
Navigation :

Descriptor

GET /v1/entities/descriptor/{entity_id}

Retrieves a specific descriptor.

Request Parameters

Location Parameter Type Required/ Optional Description
path entity_id string 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.attributes object
data.attributes.average_render_speed number The average factor faster than real time which the descriptor typically takes to render
data.attributes.bands array
data.attributes.bands[].id string The string id of the band
data.attributes.bands[].name string The string name of the band
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.max_tempo number The maximum beats per minute the descriptor is intended to be used with
data.attributes.min_tempo number The minimum beats per minute the descriptor is intended to be used with
data.attributes.name string The string name of the descriptor
data.attributes.previews array
data.attributes.previews[].content_type string enum The content type of the previews, currently audio/mp3.
data.attributes.previews[].url string The URL of the descriptor’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 descriptor, used in the descriptor field of a music Region
data.links object
data.links.self string The URL of this descriptor
data.type string The type of data (entity_descriptor in this case)
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": {
            "average_render_speed": 3.584914679030639,
            "bands": [
                {
                    "id": "documentary_minimal_intriguing_band_1",
                    "name": "Documentary Minimal Intriguing Band 1"
                },
                ...
            ],
            "instruments": [
                {
                    "id": "bongos",
                    "name": "Bongo - Clean"
                },
                ...
            ],
            "max_tempo": 120,
            "min_tempo": 100,
            "name": "Documentary Minimal Intriguing",
            "previews": [
                {
                    "content_type": "audio/mp3",
                    "url": "https://public-cdn.ampermusic.com/bands/previews/documentary_minimal_intriguing_band_5_v1.mp3"
                },
                ...
            ],
            "tags": [
                {
                    "category": {
                        "id": "sentiment",
                        "name": "Sentiment"
                    },
                    "id": "neutral",
                    "name": "Neutral"
                },
                ...
            ]
        },
        "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"
    }
}