Upload a Capture

Upload a capture to be processed.

Body Params
options
object

JSON-encoded options to configure how the file is processed.

Each org unit can have a default set of options configured, in which case this field only needs to be included to override the default.

If no default is set, this field is required.

custom_data
object

JSON-encoded custom data to associate with the capture, such as an identifier to connect the capture to after processing. Any JSON-encodable values are allowed.

file

The JPEG or MPEG-4 file to process.

IMPORTANT: Due to the nature of multipart/form-data, be sure to add the file part last!

There is currently a 200 MB file size limit.

Responses

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json