Object tracking

Follow an object through a video (a mask video)

Finds what you name ("the bottle", "the red car"; several with commas) in a video (up to 60 s) and follows it frame by frame (SAM 3). output: "mask" (the default) returns a black-and-white video of the same length — white where the object is — for an effect, a colour pop or a blur that follows the object; overlay returns the object highlighted over the video, to check what was found.

Per-frame box coordinates are not returned by the model (boxes: null). Asynchronous: poll GET /v1/executions/{id}. Price: per frame of the input video — see POST /v1/ai/track-object/estimate.

Billing: Per frame of the input video (charged per second of it). A failed request is not charged. · Rate limit: 10/min · Asynchronous

post/v1/ai/track-object

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/ai/track-object
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

x-wait-msinteger

Wait for the job inside this call (ms)

Request body

output'mask' | 'overlay'

mask (the default) = a black-and-white video of the same length, white where the object is — for effects that follow it · overlay = the object highlighted over the video (a preview)

promptstring required

What to follow, in a few words: "the bottle", "the red car" — several things with commas: "person, dog"

video_urlstring uri required

The video (up to 60 s)

duration_secondsnumber

The video's length if you know it (only for the estimate)

detection_thresholdnumber

How sure the model must be to follow something (lower finds more, less precisely; try 0.3 when nothing is found)

Response

Completed (or 202 while processing)

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.