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, title, author, enableDuplicateCheck

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,
  "title": "string",
  "author": "string",
  "enableDuplicateCheck": true
}

Information about the fields that appear on the request 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
title	No	string	Title of the audio.
author	No	string	Author of the audio.
enableDuplicateCheck	No	boolean	Determines whether duplicate audio should be disallowed.

info

If the "enableDuplicateCheck" field is set to true, the system will check for existing audios with the same content and prevent them from being uploaded again. If set to false or omitted, duplicates will be allowed.

Important: This field should be enabled for both the initial audio upload and any subsequent uploads. If not enabled initially, the system will not perform the duplicate check, and duplicates will be allowed, even if the content is the same.

Response

{
  "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.

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