Skip to main content
POST
Find visual moments

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Optional durable retry key. Reuse only for the identical logical request; a different payload returns conflict.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price and balance without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json
projectId
string
required

Project containing the footage to search.

Required string length: 1 - 200
query
string
required

Visual moment to find in the footage.

Required string length: 1 - 400
assetIds
string[]

Project asset ids to restrict the search to; omit to search all video assets.

Required array length: 1 - 50 elements
Required string length: 1 - 200
topK
integer
default:10

Maximum number of timestamped visual matches to return; defaults to 10.

Required range: 1 <= x <= 100
{key}
any

Response

Success.

success
boolean
required
hits
object[]
required
sourceCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
segmentCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
cachedIndex
boolean
required
projectId
string
required
credits
number
creditBalance
number
{key}
any