Skip to main content

POST Video


The following table contains important information about the POST method in regards to the encode process.

POST Method
URL or Endpoint/api/projects/projectId/encodes

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter NameprojectId
DescriptionUnique Id of the project.

Request Body

"downloadUrl": "",
"callBackUrl": "string"

The description of the parameters is as follows:

Body Parameter NameMandatoryTypeDescription
downloadUrlYesstringThe URL of the video that will be encoded.
callBackUrlYesstringURL that will be called when encoding is finished.


"success": true,
"errors": [],
"messages": ["Info saved with success"],
"result": {
"name": "vjsmxjtb"
"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[string]Indicates if there was an error.
messagesarray[string]Returns the response message from back-end.
resultarray[Object]Returns the response object.
namestringReturns the unique name of the encoded video.
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.


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