POST Audio Thumbnail

Overview

---

The following table contains important information about the POST method for managing process of uploading an audio thumbnail.

POST Audio Thumbnail
Method	POST
URL or Endpoint	/api/v1​/projects​/projectId​/audios/thumbnail/audioiId
Parameters	audioId, projectId
Body	folder, file

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.

Request Body

Information about the fields that appear on the body request are displayed as it follows:

Parameter Name	Mandatory	Type	Description
folder	Yes	string	Folder details
file	Yes	string($binary)	File details

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "path": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/thumbnails/retina.jpg",
    "relativePath": "audio-encode/{audioId}/thumbnails/retina.jpg",
    "blobPath": null
  },
  "resultInfo": null,
  "statusCode": 200
}

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

Field Name	Type	Description
success	bool	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	array[Object]	Returns the response object
path	string	URL to the thumbnail image
relativePath	string	Relative path to the thumbnail image
blobPath	string	Path to the blob thumbnail image
resultInfo	string	Returns extra information about the result
statusCode	integer($int32)	Returns the HTTP Status Code

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