POST
/
annotations
/
sets
/
v1

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

AnnotationSet bundles together annotation types that are related, e.g. football annotation types (goal, corner kick, red card, etc).

name
string
required

The name of the annotation set.

project_id
string
required
custom_data
object

Data that can be used to store additional information about the annotation set. This can be useful to communicate additional information to downstream systems that want to act on annotations of this set (e.g. to render overlays in a video).

disabled
boolean

Whether the annotation set should be shown in the management UI or not.

icon_asset_id
string

The asset ID of the icon. Can be left empty to show no icon.

priority
string

The priority determines the order in which the annotation sets are shown in the UI. A higher value means it shows up earlier in the list. Note: this also determines the order of the groups in the list response. The groups are ordered by the highest priority of the first element in each group.

Response

200 - application/json
set
object

AnnotationSet bundles together annotation types that are related, e.g. football annotation types (goal, corner kick, red card, etc).