Generate Video Subtitles

Overview

The following table contains important information about the POST method in regards to the auto-generating subtitles.

Post auto generated subtitles
Method	POST
Endpoint	/api/projects/{projectId}/videos/subtitles/{videoId}
Headers	Authorization
Parameters	projectId, videoId
Body	None

The description of the URL parameters is as follows:

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

Response:

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "status": 1,
    "statusName": "Pending"
  },
  "resultInfo": null,
  "statusCode": 200
}

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	arrasy[Object]	Returns the response object
status	id	The id of the auto-generated subtitle status
statusName	string	The name of the auto-generated subtitle status
resultInfo	string	Returns extra information about the result
statusCode	integer($int32)	Returns the HTTP Status Code

status	statusName	Description
1	“Pending”	Auto generated subtitles for the specific video added
4	“Failed”	Auto generated subtitle for the specific video already added

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