POST Audio to Podcast
Overview
The following table contains important information about the POST
method for managing the process of uploading an audio into a specific podcast.
POST Audio to Podcast | |
---|---|
Method | POST |
URL or Endpoint | /api/v1/projectId /podcasts/audios |
Parameters | projectId |
Body | Check the body below |
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
{
"podcastId": "string",
"audioId": "string",
"position": 0
}
Information about the fields that appear on the response body are displayed in the table below.
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
podcastId | Yes | string | The unique identifier for the podcast. |
audioId | Yes | string | The unique identifier for the audio file. |
position | No | integer | The position of the audio in the podcast. |
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"podcastId": "{podcastId}",
"audioId": "{audioId}",
"position": 0
},
"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, it will return false. |
errors | array[string] | Indicates if there was an error. |
messages | array[string] | Returns the response message from the backend. |
result | object | Returns the response object containing the detailed result. |
podcastId | string | The unique identifier for the podcast. |
audioId | string | The unique identifier for the audio file. |
position | integer | The position of the audio in the podcast |
resultInfo | object | Additional information about the result. |
statusCode | integer | The HTTP status code of the response. |
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