Skip to main content
Get the environments, objects, and actions found in a dataset.

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 ID from GET /api/quality/datasets.

vocabulary
string | null

Opaque vocabulary token from an earlier response. Omit to use the latest vocabulary.

section
string | null

Return only environments, objects, or actions.

Response

Published vocabulary by section

Published dataset vocabulary and coverage.

clips_analyzed
integer
required

Clips included in the vocabulary analysis.

Required range: x >= 0
dataset
string
required

Dataset ID used in the request.

sections
object[]
required
segments_unassessed
integer
required

Segments of footage that could not be assessed.

Required range: x >= 0
segments_unusable
integer
required

Segments whose assessment was unusable.

Required range: x >= 0
vocabulary
string
required

Opaque vocabulary token. Matching tokens identify results from the same vocabulary measurement.