☰
Navigation :

Quick Reference

HTTP

Attribute Description
Base URL api.ampermusic.com
Version HTTP/1.1
Security All requests must use HTTPS on port 443

Request Headers

Header Description
Host: api.ampermusic.com Host header must be included in all requests
Content-Type: application/vnd.api+json JSON is the only supported content type
If-Match: <valid ETag value> An If-Match header must be included in all requests that modify data, and it must match the ETag value on the server
Authorization: <username:password> Use a valid API token as the username and a blank password. Base64 encoded
Authorization: Bearer <credentials> Use a valid API token as the credentials

Response Headers

Header Description
Content-Type: application/vnd.api+json JSON is the only supported content type
ETag: <valid ETag value> Reponses that include data return ETag headers
Location: <url> The URL location of the requested data

Methods and URLs

Music

Renders

Method URL Description
GET /v1/simple_renders/{id} Retrieves information for a simple render
POST /v1/simple_renders Creates a simple render

Compositions

Method URL Description
GET /v1/simple_compositions/{id} Retrieves information for a simple composition
POST /v1/simple_compositions Creates a simple composition

Entities

Method URL Description
GET /v1/entities/descriptor/{entity_id} Retrieves information for an individual descriptor
GET /v1/entities/descriptor Retrieves information for multiple descriptors
GET /v1/entities/band/{entity_id} Retrieves information for an individual band
GET /v1/entities/band Retrieves information for multiple bands
GET /v1/entities/category/{entity_id} Retrieves information for an individual category
GET /v1/entities/category Retrieves information for multiple categories
GET /v1/entities/descriptor/{entity_id} Retrieves information for an individual descriptor
GET /v1/entities/descriptor Retrieves information for multiple descriptors
GET /v1/entities/hit/{entity_id} Retrieves information for an individual hit
GET /v1/entities/hit Retrieves information for multiple hits
GET /v1/entities/instrument/{entity_id} Retrieves information for an individual instrument
GET /v1/entities/instrument Retrieves information for multiple instruments
GET /v1/entities/label/{entity_id} Retrieves information for an individual label
GET /v1/entities/label Retrieves information for multiple labels
GET /v1/entities/tag/{entity_id} Retrieves information for an individual tag
GET /v1/entities/tag Retrieves information for multiple tags

Miscellaneous

Method URL Description
GET /v1/ping Pings the Amper platform
POST /v1/validations/email Validates an email address
POST /v1/validations/password Validates a password

Response Status Codes

Status Code Description
200 OK The request was successful. The object was found and returned
201 Created The object was successfully created. The message body contains its current state. If present, the Location header contains the URL for the new object
202 Accepted The request was successfully accepted. Further processing will be performed
204 No Content The request was successful. The response contains no content
400 Bad Request The system was unable to process the request because it was malformed
401 Unauthorized The request was unsuccessful because of an authentication failure
404 Not Found A path or ID specified in the URL does not exist. This code is also returned in cases where an object does exist in the system, but it does not belong to authenticated user
405 Method Not Allowed The requested method cannot be performed on the specified object
409 Conflict The object could not be created because it conflicts with an existing object. Ensure the user-defined project name is unique for the user
412 Precondition Failed An object could not be updated or deleted because the If-Match request header does not match the ETag of the resource on the server
415 Unsupported Media Type The Content-Type header is missing or set to an unsupported value. Ensure the Content-Type header is set to application/vnd.api+json
422 Unprocessable Entity A POST request was parsable, but failed a validation check. A required property was either missing or a value was invalid
429 Too Many Requests The request was rejected because too many similar requests have been submitted in a short amount of time. Wait and try submitting requests later