Skip to main content

POST Cut and Publish Live Video

Overview


The table below provides key details about the POST method for cutting and publishing Live Video

POST Cut and Publish Live Video
MethodPOST
URL or Endpoint/api/v1/projectId/live-videos/cut-and-publish
HeadersAuthorization
ParametersprojectId
Request BodyTitle, VideoPublicId, FromMilisecond, ToMilisecond, VideoVisibilityOptionId

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"title": "string",
"videoPublicId": "string",
"fromMilisecond": 0,
"toMilisecond": 0,
"videoVisibilityOptionId": 0
}

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

Field NameTypeDescription
titlestringTitle of the video
videoPublicIdstringUnique identifier for the video
fromMilisecondinteger($int32)Indicates the starting point in miliseconds from where the video should be cut
fromMilisecondinteger($int32)Indicates the ending point in miliseconds where the video should be cut
videoVisibilityOptionIdinteger($int32)Specifies the visibility option for the video

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"videoPublicId": "{videoId}",
"name": null,
"originalFile": null
},
"resultInfo": null,
"statusCode": 200
}

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

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
videoPublicIdstringReturns public identifier of the video
namestringReturns name of the video
originalFilestringReturn original file of the video
resultarray[Object]Returns the response object.
resultInfostringReturns extra information about the result.
statusCodeinteger($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