Skip to main content
POST
Detect faces in video

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Face detection request parameters

url
string
required

URL of the target video to analyze

frame_extraction_id
string<uuid>

Optional: Use previously extracted frames

frame_extraction_config
object

Optional: Frame extraction configuration

Response

Face detection job created successfully

face_detection_id
string<uuid>
required

Unique identifier for the face detection job

status
enum<string>
required

Status of the face detection job

Available options:
pending,
processing,
completed,
failed
created_at
number
required

Unix timestamp in milliseconds when the job was created

frame_extraction_id
string<uuid>

ID of the frame extraction used

file_id
string<uuid>

ID of the target file

data
object

Face detection results (only present when status is completed)