POST Audio

Overview

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

POST Audio
Method	POST
URL or Endpoint	/api/v1/`projectId`/audios
Parameters	projectId
Body	downloadUrl, callBackUrl, hasDrm, folderId

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
`projectId`	Yes	string	Unique Id of the project.

Request Body

{
  "downloadUrl": "string",
  "callBackUrl": "string",
  "hasDrm": true,
  "folderId": 0
}

Information about the fields that appear on the response body are displayed in the table below.

Parameter Name	Mandatory	Type	Description
downloadUrl	Yes	string	URL to download the audio
callBackUrl	No	string	URL for callback after processing
hasDrm	No	bool	Indicates if DRM is enabled
folderId	No	integer($int32)	Identifier of the folder

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "{publicId}"
  },
  "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
publicId	string	Unique identifier of the audio
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.

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