VisionAPI ReferenceV2

Segment

Authentication

X-Api-Keystring

API key authentication via X-Api-Key header

OR
AuthorizationBearer
Bearer token authentication via Authorization header

Path parameters

video_idstringRequired

Request

This endpoint expects an object.
promptslist of objectsRequired
Objects to detect. Each prompt is run against every sampled frame.
startdoubleOptional>=0Defaults to 0
Start of time range in seconds.
enddouble or nullOptional>=0

End of time range in seconds. Defaults to start + 15s, clamped to video duration. Max range is 15 seconds.

thresholddoubleOptional0-1Defaults to 0.3
Confidence threshold. Detections below this score are excluded.

Response

Successful Response
frameslist of objects
frame_sizeobject or null
frame_countinteger