List annotation types

GET

annotations

types

curl --request GET \
  --url https://api.mottostreaming.com/annotations/types/v1 \
  --header 'Authorization: Bearer <token>'

{
  "types": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "set_id": "<string>",
      "name": "<string>",
      "icon_asset_id": "<string>",
      "priority": "<string>",
      "group_name": "<string>",
      "disabled": true,
      "visibility": "VISIBILITY_UNSPECIFIED",
      "delay": "<string>",
      "custom_data": {},
      "entity_types": [
        "<string>"
      ],
      "kind": "KIND_UNSPECIFIED"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

project_id

string

filter

string

Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported. E.g. set_id:football and disabled:false

Note: set_id is mandatory.

Response

200

application/json

types

object[]

Annotation is an invocation of an annotation type and represents a single moment in a video that represents an occurrence of that annotation type. For example, if you have an annotation type "goal", then an Annotation could created when a goal occurs in the video.

types.project_id

string

required

types.set_id

string

required

The ID of the set this annotation type belongs to. This is used to group annotation types together. For example, if the id field is set to goal, the set ID might be set to football. Another annotation type corner_kick might belong to the same set. This should not be confused with the group_name field, which is used to group annotation types in the UI (within a single set).

types.name

string

required

The name of the annotation type.

types.id

string

System generated unique identifier for the annotation type.

types.icon_asset_id

string

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

types.priority

string

The priority determines the order in which the annotation types 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.

types.group_name

string

The group name is used to group annotation types in the UI. For example, all annotation types related to time-keeping (like kickoff, half_time or full_time) might be grouped under the group name "Time". This can be any name you'd like to assign to it.

types.disabled

boolean

Whether the annotation type should be shown in the tagging UI of the Studio.

types.visibility

enum<string>

The visibility of annotations of this type to end users. This may be overwritten by the visibility of individual annotations.

Available options:

VISIBILITY_UNSPECIFIED,

VISIBILITY_PUBLISHED,

VISIBILITY_UNLISTED,

VISIBILITY_HIDDEN

types.delay

string

Optional. The number of milliseconds to wait before an annotation of this type starts triggering associated actions. It is recommended to set this to a value that is high enough to allow for Studio operators to delete the annotation in case of a mistaken click on an annotation. Important: this is only a hint to the UI client (the client is responsible for handling the delay).

types.custom_data

object

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

types.entity_types

string[]

Optional. The CMS entity types that are associated with annotations of this type. For example, if your annotation type is "goal", you might want to associate it with the entity type "team". The Motto Studio (or another custom-built client) will use this information to show a dialog to the tagger to provide this information when the annotation is created. This information can then be used in downstream services.

Important: Make sure that such an entity type exists in the CMS, first.

types.kind

enum<string>

An indicator of what kind of annotation this is. This is mainly useful so that the system can reason better about what this annotation represents. However, this is not a required field, and not all annotation types need to have a kind. When possible, it is recommended to provide it.

This should match the sport as it is configured on the annotation set.

Available options:

KIND_UNSPECIFIED,

KIND_SOCCER_GOAL,

KIND_SOCCER_CORNER_KICK,

KIND_SOCCER_FREE_KICK,

KIND_SOCCER_PENALTY_KICK,

KIND_SOCCER_THROW_IN,

KIND_SOCCER_FOUL,

KIND_SOCCER_YELLOW_CARD,

KIND_SOCCER_RED_CARD,

KIND_SOCCER_SUBSTITUTION,

KIND_SOCCER_KICKOFF,

KIND_SOCCER_HALF_TIME,

KIND_SOCCER_FULL_TIME,

KIND_SOCCER_EXTRA_TIME,

KIND_SOCCER_OVER_TIME,

KIND_SOCCER_PENALTY_SHOOTOUT,

KIND_SOCCER_MATCH_END,

KIND_AMERICAN_FOOTBALL_TOUCHDOWN,

KIND_AMERICAN_FOOTBALL_FIELD_GOAL,

KIND_AMERICAN_FOOTBALL_SAFETY,

KIND_AMERICAN_FOOTBALL_KICKOFF,

KIND_AMERICAN_FOOTBALL_PUNT,

KIND_AMERICAN_FOOTBALL_FUMBLE,

KIND_AMERICAN_FOOTBALL_INTERCEPTION,

KIND_AMERICAN_FOOTBALL_FIRST_DOWN,

KIND_AMERICAN_FOOTBALL_TIMEOUT,

KIND_AMERICAN_FOOTBALL_END_OF_QUARTER,

KIND_AMERICAN_FOOTBALL_END_OF_HALF,

KIND_AMERICAN_FOOTBALL_END_OF_GAME,

KIND_FUTSAL_GOAL,

KIND_FUTSAL_CORNER_KICK,

KIND_FUTSAL_FREE_KICK,

KIND_FUTSAL_PENALTY_KICK,

KIND_FUTSAL_THROW_IN,

KIND_FUTSAL_FOUL,

KIND_FUTSAL_YELLOW_CARD,

KIND_FUTSAL_RED_CARD,

KIND_FUTSAL_SUBSTITUTION,

KIND_FUTSAL_KICKOFF,

KIND_FUTSAL_HALF_TIME,

KIND_FUTSAL_FULL_TIME,

KIND_FUTSAL_EXTRA_TIME,

KIND_FUTSAL_OVER_TIME,

KIND_FUTSAL_PENALTY_SHOOTOUT,

KIND_FUTSAL_MATCH_END,

KIND_HANDBALL_GOAL,

KIND_HANDBALL_FREE_THROW,

KIND_HANDBALL_PENALTY_THROW,

KIND_HANDBALL_THROW_IN,

KIND_HANDBALL_FOUL,

KIND_HANDBALL_YELLOW_CARD,

KIND_HANDBALL_RED_CARD,

KIND_HANDBALL_SUBSTITUTION,

KIND_HANDBALL_KICKOFF,

KIND_HANDBALL_HALF_TIME,

KIND_HANDBALL_FULL_TIME,

KIND_HANDBALL_EXTRA_TIME,

KIND_HANDBALL_OVER_TIME,

KIND_HANDBALL_PENALTY_SHOOTOUT,

KIND_HANDBALL_MATCH_END,

KIND_BASKETBALL_FIELD_GOAL,

KIND_BASKETBALL_FREE_THROW,

KIND_BASKETBALL_THREE_POINTER,

KIND_BASKETBALL_FOUL,

KIND_BASKETBALL_TIMEOUT,

KIND_BASKETBALL_SUBSTITUTION,

KIND_BASKETBALL_END_OF_QUARTER,

KIND_BASKETBALL_END_OF_HALF,

KIND_BASKETBALL_END_OF_GAME,

KIND_VOLLEYBALL_POINT,

KIND_VOLLEYBALL_SERVE,

KIND_VOLLEYBALL_BLOCK,

KIND_VOLLEYBALL_SPIKE,

KIND_VOLLEYBALL_TIMEOUT,

KIND_VOLLEYBALL_SUBSTITUTION,

KIND_VOLLEYBALL_END_OF_SET,

KIND_VOLLEYBALL_END_OF_MATCH,

KIND_RUGBY_TRY,

KIND_RUGBY_CONVERSION,

KIND_RUGBY_PENALTY_GOAL,

KIND_RUGBY_DROP_GOAL,

KIND_RUGBY_FOUL,

KIND_RUGBY_YELLOW_CARD,

KIND_RUGBY_RED_CARD,

KIND_RUGBY_SUBSTITUTION,

KIND_RUGBY_KICKOFF,

KIND_RUGBY_HALF_TIME,

KIND_RUGBY_FULL_TIME,

KIND_RUGBY_EXTRA_TIME,

KIND_RUGBY_OVER_TIME,

KIND_RUGBY_MATCH_END,

KIND_CRICKET_RUN,

KIND_CRICKET_WICKET,

KIND_CRICKET_NO_BALL,

KIND_CRICKET_WIDE_BALL,

KIND_CRICKET_FOUR,

KIND_CRICKET_SIX,

KIND_CRICKET_OVER,

KIND_CRICKET_INNINGS_BREAK,

KIND_CRICKET_MATCH_END,

KIND_BASEBALL_RUN,

KIND_BASEBALL_HIT,

KIND_BASEBALL_HOME_RUN,

KIND_BASEBALL_STRIKE,

KIND_BASEBALL_BALL,

KIND_BASEBALL_OUT,

KIND_BASEBALL_INNING_END,

KIND_BASEBALL_MATCH_END,

KIND_SOFTBALL_RUN,

KIND_SOFTBALL_HIT,

KIND_SOFTBALL_HOME_RUN,

KIND_SOFTBALL_STRIKE,

KIND_SOFTBALL_BALL,

KIND_SOFTBALL_OUT,

KIND_SOFTBALL_INNING_END,

KIND_SOFTBALL_MATCH_END,

KIND_FIELD_HOCKEY_GOAL,

KIND_FIELD_HOCKEY_PENALTY_CORNER,

KIND_FIELD_HOCKEY_FREE_HIT,

KIND_FIELD_HOCKEY_FOUL,

KIND_FIELD_HOCKEY_YELLOW_CARD,

KIND_FIELD_HOCKEY_RED_CARD,

KIND_FIELD_HOCKEY_SUBSTITUTION,

KIND_FIELD_HOCKEY_KICKOFF,

KIND_FIELD_HOCKEY_HALF_TIME,

KIND_FIELD_HOCKEY_FULL_TIME,

KIND_FIELD_HOCKEY_EXTRA_TIME,

KIND_FIELD_HOCKEY_OVER_TIME,

KIND_FIELD_HOCKEY_PENALTY_SHOOTOUT,

KIND_FIELD_HOCKEY_MATCH_END,

KIND_ICE_HOCKEY_GOAL,

KIND_ICE_HOCKEY_PENALTY,

KIND_ICE_HOCKEY_POWER_PLAY,

KIND_ICE_HOCKEY_FOUL,

KIND_ICE_HOCKEY_YELLOW_CARD,

KIND_ICE_HOCKEY_RED_CARD,

KIND_ICE_HOCKEY_SUBSTITUTION,

KIND_ICE_HOCKEY_KICKOFF,

KIND_ICE_HOCKEY_HALF_TIME,

KIND_ICE_HOCKEY_FULL_TIME,

KIND_ICE_HOCKEY_EXTRA_TIME,

KIND_ICE_HOCKEY_OVER_TIME,

KIND_ICE_HOCKEY_PENALTY_SHOOTOUT,

KIND_ICE_HOCKEY_MATCH_END,

KIND_BEACH_SOCCER_GOAL,

KIND_BEACH_SOCCER_CORNER_KICK,

KIND_BEACH_SOCCER_FREE_KICK,

KIND_BEACH_SOCCER_PENALTY_KICK,

KIND_BEACH_SOCCER_THROW_IN,

KIND_BEACH_SOCCER_FOUL,

KIND_BEACH_SOCCER_YELLOW_CARD,

KIND_BEACH_SOCCER_RED_CARD,

KIND_BEACH_SOCCER_SUBSTITUTION,

KIND_BEACH_SOCCER_KICKOFF,

KIND_BEACH_SOCCER_HALF_TIME,

KIND_BEACH_SOCCER_FULL_TIME,

KIND_BEACH_SOCCER_EXTRA_TIME,

KIND_BEACH_SOCCER_OVER_TIME,

KIND_BEACH_SOCCER_PENALTY_SHOOTOUT,

KIND_BEACH_SOCCER_MATCH_END,

KIND_BEACH_VOLLEYBALL_POINT,

KIND_BEACH_VOLLEYBALL_SERVE,

KIND_BEACH_VOLLEYBALL_BLOCK,

KIND_BEACH_VOLLEYBALL_SPIKE,

KIND_BEACH_VOLLEYBALL_TIMEOUT,

KIND_BEACH_VOLLEYBALL_SUBSTITUTION,

KIND_BEACH_VOLLEYBALL_END_OF_SET,

KIND_BEACH_VOLLEYBALL_END_OF_MATCH,

KIND_BEACH_HANDBALL_GOAL,

KIND_BEACH_HANDBALL_FREE_THROW,

KIND_BEACH_HANDBALL_PENALTY_THROW,

KIND_BEACH_HANDBALL_THROW_IN,

KIND_BEACH_HANDBALL_FOUL,

KIND_BEACH_HANDBALL_YELLOW_CARD,

KIND_BEACH_HANDBALL_RED_CARD,

KIND_BEACH_HANDBALL_SUBSTITUTION,

KIND_BEACH_HANDBALL_KICKOFF,

KIND_BEACH_HANDBALL_HALF_TIME,

KIND_BEACH_HANDBALL_FULL_TIME,

KIND_BEACH_HANDBALL_EXTRA_TIME,

KIND_BEACH_HANDBALL_OVER_TIME,

KIND_BEACH_HANDBALL_PENALTY_SHOOTOUT,

KIND_BEACH_HANDBALL_MATCH_END

Get annotation type Create annotation type

curl --request GET \
  --url https://api.mottostreaming.com/annotations/types/v1 \
  --header 'Authorization: Bearer <token>'

{
  "types": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "set_id": "<string>",
      "name": "<string>",
      "icon_asset_id": "<string>",
      "priority": "<string>",
      "group_name": "<string>",
      "disabled": true,
      "visibility": "VISIBILITY_UNSPECIFIED",
      "delay": "<string>",
      "custom_data": {},
      "entity_types": [
        "<string>"
      ],
      "kind": "KIND_UNSPECIFIED"
    }
  ]
}

Get Started

Studio API

Content Delivery API

Deep dive

List annotation types

Authorizations

Query Parameters

Response