Get a Simple Render

GET /v1/simple_renders/{id}

Retrieves a simple render.

Request Parameters

Location Parameter Type Required/ Optional Description
path id string required The alphanumeric ID of the simple render

Example Request

GET /v1/simple_renders/abcd1234  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 (simple_renders in this case)
data.id string The alphanumeric ID of the simple render
data.attributes object
data.attributes.timeline object The timeline data. See Timelines for details
data.attributes.status string enum A coarse progress indicator. One of the following values:
WAITING_COMPOSE — The job is waiting to start the composition phase
RUNNING_COMPOSE — The job is actively being composed
WAITING_RENDER — The job’s composition is done; waiting to start the rendering phase
RUNNING_RENDER — The job is actively being rendered
CREATED — The job has finished and all files have been created
FAILED_CREATE — The job did not complete successfully and no further work will be performed
data.attributes.progress_percent number Indicates the current progress as percent complete (0% to 100%). If the render has not started, or it has finished, the value is null
data.attributes.files array
data.attributes.files[].tracks array An array of track names included in the file
data.attributes.files[].content_type string The content-type of the file
data.attributes.files[].inner_content_type string If the file is an archive (zip, etc.), the content-type of the files contained within
data.attributes.files[].frequency_hz number The Sample rate of the audio files in Hertz (Hz)
data.attributes.files[].bits_sample number The bit depth of the audio files in bits/sample
data.attributes.files[].kbits_second number The data rate of the audio files in kilobits/second
data.attributes.files[].channel_count number The channel count of the audio files (1 or 2)
data.attributes.files[].download_url string The internet-accessible URL from which the file can be downloaded. Any redirects encountered when using this URL must be followed
data.attributes.files[].attachment_filename string A user-specified download filename hint
data.attributes.files[].download_etag string The Etag of the audio/zip file from storage, primarily used for caching. If a file has an ETag already, downloading is unnecessary
data.attributes.files[].size_bytes number Size of the file in bytes
data.attributes.date_create date The date and time the render was created
data.attributes.date_update date The date and time the render was last updated
data.attributes.preset string A preset name to simplify file format selection (MASTER_MP3, MASTER_WAV, STEMS_WAV)
data.attributes.queue_position integer null If an integer, the render’s place in line. If null, there is no wait time for the render
data.links object
data.links.self string The URL of the render
links object
links.self string The URL of this render

Note: All dates are formatted as ISO-8601 date and time strings. For example, 2018-08-08T08:08:08+00:00.

Example Response

Header

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

Body

{
    "data": {
        "type": "simple_renders",
        "id": "abcd1234",
        "attributes": {
            "timeline": {
                <timeline data>
            },
            "status": "created",
            "progress_percent": null,
            "files": [
                {
                    "tracks": ["master"],
                    "content_type": "audio/mp3",
                    "inner_content_type": null,
                    "frequency_hz": 44100,
                    "bits_sample": 16,
                    "kbits_second": 192,
                    "channel_count": 2,
                    "download_url": "https://example.com/download-001.mp3",
                    "attachment_filename": "Project 001.mp3",
                    "size_bytes": 3434343
                },
                {
                    "tracks": ["master"],
                    "content_type": "audio/mp3",
                    "inner_content_type": null,
                    "frequency_hz": 44100,
                    "bits_sample": 16,
                    "kbits_second": 192,
                    "channel_count": 2,
                    "download_url": "https://example.com/download-002.mp3",
                    "attachment_filename": "Project 002.mp3",
                    "size_bytes": 7599131
                }
            ],
            "date_create": "2018-08-08T08:08:08+00:00",
            "date_update": "2018-08-08T08:08:08+00:00"
        },
        "links": {
            "self": "https://api.ampermusic.com/v1/simple_renders/abcd1234"
        }
    },
    "links": {
        "self": "https://api.ampermusic.com/v1/simple_renders/abcd1234"
    }
}