API ReferenceExtract video data

Retrieve text recognized in video (OCR)

This method retrieves text recognized in video (OCR).

Path parameters

index-idstringRequired

The unique identifier of the index to which the video has been uploaded.

video-idstringRequired

The unique identifier of the video.

Headers

x-api-keystringRequired

Query parameters

startdoubleOptional

The start of the time range (in seconds) to retrieve OCRs for.

enddoubleOptional

The end of the time range (in seconds) to retrieve OCRs for.

Response

OCRs have successfully been retrieved.

idstringOptional

The unique identifier of the video.

datalist of objectsOptional

An array that contains the OCR elements. For each time range for which the platform finds OCR elements, it returns an object that contains the fields below. If the platform doesn’t find any OCR elements, the data field is set to None.

index_idstringOptional

The unique identifier of the index to which the video has been updated.

Errors