Skip to main content
POST
/
api
/
classification_video
Classify a video
curl --request POST \
  --url https://backend.identifai.net/api/classification_video \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --form 'ref_id=<string>' \
  --form frames=5 \
  --form key_frames=true \
  --form key_frames_method=iframes \
  --form with_morphing=true \
  --form with_tampering=false \
  --form video='@example-file' \
  --form webhook_url=https://example-webhook.com
{
  "identifier": "8d64370a87b820cc1cf620338f5c898bab37439c9a405f32d9eaffc50c4f27b0"
}

Authorizations

ā€‹
X-Api-Key
string
header
required

Your API key.

Body

multipart/form-data
ā€‹
video
file
required

The video to be classified. Supported formats: Any video format (MP4, AVI, MOV, etc.). MIME types: Any mimetype starting with 'video/' (e.g., video/mp4, video/avi, video/quicktime). Maximum file size: 5GB.

ā€‹
ref_id
string

An optional reference ID to associate with the classification request.

ā€‹
frames
enum<integer>

Choose to classify a maximum of 5, 10 or 30 frames.

Available options:
5,
10,
30
ā€‹
key_frames
boolean

If set to true extracts key frames and uses those for classification instead of fixed-time distance images. The extracted key frames may be less than the requested frames.

ā€‹
key_frames_method
enum<string>

Key frames identification algorithm. Possible values are iframes (default), flow and color.

  • iframes : extracts the iframes of the video;
  • color : returns the average frame, based on color, of every shot sequence. Shot sequences are group of frames that start with an iframe;
  • flow : returns the most still frame with respect of the previous frame of every shot sequence.
Available options:
iframes,
flow,
color
ā€‹
with_morphing
boolean

Set it to true if you also want to analyze people's faces in the image using morphing.

ā€‹
webhook_url
string

If specified, the classification result will also be automatically sent to the entered URL. Otherwise, the result can be obtained by polling the relative endpoint. Please note that in order to use a webhook callback URL you need to request a specific enablement, otherwise the parameter is ignored. Moreover, the system may cache the analysis results of repeated submissions, i.e. submissions of the same file with the same options: in this case the webhook won't be called and the results would be accessible only by polling the relative endpoint.

Response

The classification identifier. The format depends on the Accept header.

ā€‹
identifier
string
Example:

"8d64370a87b820cc1cf620338f5c898bab37439c9a405f32d9eaffc50c4f27b0"