Skip to main content
Every analysed clip of an enriched corpus, with everything measured about it: where it was shot, what it contains, how its frames partition, and how long hands were visible and manipulating.

Authorizations

Authorization
string
header
required

Capability-bearing token issued by a squash operator. Required for curation, exports, dataset registration, and job control when the deployment runs in gated mode; public reads stay open. GET /api/access reports the capabilities a given credential actually carries.

Query Parameters

dataset
string
required

Dataset or corpus id whose index root holds the enrichment.

vocabulary
string | null

Stored vocabulary classification. Omit for the most recent.

term
string | null

Only clips carrying this published term or a spelling that merged into one, in any section. Matching is evidence-based: a spelling no window ever produced selects nothing.

frame_quality
boolean | null

Join each clip's frame counts from the most recent frame-quality run.

A flag rather than an address, unlike the corpus-level routes: those name the run their whole answer is about, whereas this adds columns to rows the vocabulary already chose. Off by default because each joined column costs one stored read per clip on the page.

hand_activity
boolean | null

Join each clip's hand-visibility seconds from the most recent hand-activity run.

offset
integer | null

Number of matching clips to skip (default 0).

Required range: x >= 0
limit
integer | null

Maximum matching clips returned (default 100, maximum 1000).

Required range: x >= 0

Response

A page of analysed clips

Response of GET /api/quality/clips.

clips
object[]
required

The offset/limit slice, ordered by episode index; clips whose runs disagree about an index sort last, by identity.

dataset
string
required
filtered_to
object[]
required

What term resolved to, per section it is published in — a query can name a term in more than one, and the clips are the UNION, so every contributor is stated rather than the first. Empty when no term was given.

limit
integer
required
Required range: x >= 0
offset
integer
required
Required range: x >= 0
total
integer
required

Clips matching the filter before pagination.

Required range: x >= 0
vocabulary
string
required

The classification these rows were built from — the one asked for, or the most recent when none was named.