GET Audio Assets

Overview

---

The following table contains information about the GET method in regards to retrieving the assets of an audio.

GET Audio Assets
Method	GET
URL or Endpoint	/api/v1/projectId/audios/audioId/assets
Headers	Authorization
Parameters	audioId, projectId, anyStatus, signedUrl
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique ID of the project.
audioId	Yes	string	Unique ID of the audio.

The description of the query parameters is as follows:

Parameter Name	Mandatory	Type	Description
anyStatus	No	boolean	Audio status value.
signedUrl	No	boolean	If set to false, all returned streaming URLs will exclude the secure token part even if secure tokens are enabled for the project.

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "originalFile": "{originalFile}",
    "originalFileName": "{originalFileName}",
    "originalFileSize": 0,
    "uploadFileDetailsId": 0,
    "thumbnail": null,
    //If audio contains chapters, the URL of the VTT File will apear like this: 
    "chaptersVtt": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/hls/chapter.vtt",
    "streamResponse": {
      "keyId": null,
      "contentId": "{contentId}",
      "progress": 100,
      "progressTillReadiness": null,
      "status": "Complete",
      "errorId": null,
      "error": null,
      "encodingProcessRemainingTime": 0,
      "insertDate": "2024-12-24T13:09:27.4701458",
      "encodingProcessFinishTime": "2024-06-10T12:12:30.9299262Z",
      "streams": [
        {
          "assetType": "Audio",
          "streamType": "hls",
          "root": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/hls/master_file.m3u8",
          "qualityTypes": [
            {
              "id": "{audioId}",
              "mediaType": "Audio",
              "qualityType": "{qualityType}",
              "streamUrl": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/hls/{qualityType}/audio/index.m3u8",
              "statusDescription": "{statusDescription}",
              "status": "{status}",
              "duration": 19.722449,
              "size": 318946,
              "width": 0,
              "height": 0,
              "bitrate": 0,
              "audioCodec": "{audioCodec}",
              "audioBitrate": 0,
              "audioSampleRate": 0,
              "progress": 100,
              "startDateTime": "2025-02-14T13:08:28.129Z",
              "endDateTime": "2025-02-14T13:08:28.129Z"
            }
          ]
        },
        {
          "assetType": "Audio",
          "streamType": "{streamType}",
          "root": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/{streamType}/master_file.m3u8",
          "qualityTypes": [
            {
              "id": "{audioId}",
              "mediaType": "Audio",
              "qualityType": "{qualityType}",
              "streamUrl": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/{streamType}/{qualityType}.mp3",
              "statusDescription": "{statusDescription}",
              "status": "{status}",
              "duration": 19.722449,
              "size": 318946,
              "width": 0,
              "height": 0,
              "bitrate": 0,
              "audioCodec": "{audioCodec}",
              "audioBitrate": 0,
              "audioSampleRate": 0,
              "progress": 100,
              "startDateTime": "2025-02-14T13:08:28.129Z",
              "endDateTime": "2025-02-14T13:08:28.129Z"
            }
          ]
        }
      ]
    }
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Top-Level Properties

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	object	Returns the response object
originalFile	string	A unique identifier for the original audio file
originalFileName	string or null	The name of the original audio file
originalFileSize	integer or null	The size of the original audio file
uploadFileDetailsId	integer or null	Identifier of the upload file details.
thumbnail	string	URL of the default thumbnail image of the audio
chaptersVTT	string	URL of the VTT file for chapters
streamResponse	object	Stream response object containing encoding status and streams.
resultInfo	string	Returns extra information about the result
statusCode	integer	Returns the HTTP Status Code

streamResponse Properties

Field Name	Type	Description
keyId	string	Id of the key
contentId	string	Id of the content
progress	integer	Overall progress of the encoding process
progressTillReadiness	integer	Progress until the audio is ready
status	string	Current status of the encoding process
errorId	integer	Unique identifier for the error
error	string	Description of the error
encodingProcessRemainingTime	integer	Time remaining for encoding to complete
insertDate	string($date-time)	Date and time when the audio was inserted
encodingProcessFinishTime	string($date-time)	Timestamp of when the encoding finished
streams	array[object]	Array of stream objects.

streams Properties

Field Name	Type	Description
assetType	string	Type of media
streamType	string	Format of the stream (hls, mp3, flac)
root	string	The URL of the root stream file.
qualityTypes	array[object]	Array of quality type objects.

qualityTypes Properties

Field Name	Type	Description
id	string	Unique identifier for this particular quality
mediaType	string	Type of the media
qualityType	string	Describes the quality of the stream (e.g., 128kbps, 192kbps, 320kbps)
streamUrl	string	URL to access specific quality stream
statusDescription	string	Description of the current status
status	string	Status of the quality stream
duration	double	Duration of the stream in seconds
size	integer	Size of the stream file in bytes
width	integer	Width of the audio in pixels
height	integer	Height of the audio in pixels
bitrate	integer	Bitrate of the stream in bits per second
audioCodec	string	Codec used for the audio stream
audioBitrate	integer	Bitrate of the audio stream in Hz
audioSampleRate	integer	Sample rate of the audio stream in Hz
progress	integer	Progress of encoding for this quality type
startDateTime	string($date-time)	The UTC timestamp when the process begins.
endDateTime	string($date-time)	The UTC timestamp when the process ends.

info

For more information about the possible errorId and error values, see Error Codes.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed