Get Started
Studio API
- Introduction
- Streaming
- CMS
- Events
- Creative Works
- Entities
- Content Types
- Annotations
- GETGet annotation
- GETList annotations
- POSTCreate annotation
- PATCHUpdate annotation
- DELDelete annotation
- Annotation Types
- Annotation Sets
- Action Types
- Action Secrets
- GET
- OTT
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
Get action type
GetActionType
Returns an action type
curl --request GET \
--url https://api.mottostreaming.com/annotations/action_types/v1/{action_type_id} \
--header 'Authorization: Bearer <token>'{
"action_type": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"category": "<string>",
"input_fields": [
{
"field": "<string>",
"description": "<string>",
"type": "<string>",
"default_value": "<any>",
"secret": true
}
],
"output_fields": [
{
"field": "<string>",
"description": "<string>",
"type": "<string>"
}
],
"disabled": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
ActionType is a single action type definition that gets invoked when an annotation is created.
System generated unique identifier for the action type. E.g. create_clip
The name of the action type. E.g. Create Clip
The description of the action type.
(Optional) An image url that represents the action type. This is used in the UI to show the action type.
A category of the action type. This is meant to group action types together in the UI.
The input fields for the action type.
The input field. E.g. clip_name or asset_id.
The description of the input field.
The type of the input field. The value can be either string, number, bool or 'object'.
The default value of the input field.
If the input field is a secret. The default value is false. When set to true, the UI will recommend using the
action secrets system to store the value of this field.
The output fields for the action type.
If the action type is disabled. The default value is false. When set to true, this action type can no longer
be selected to be executed on a newly created annotation type (but it may still be executed on existing annotation type invocations).
curl --request GET \
--url https://api.mottostreaming.com/annotations/action_types/v1/{action_type_id} \
--header 'Authorization: Bearer <token>'{
"action_type": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"category": "<string>",
"input_fields": [
{
"field": "<string>",
"description": "<string>",
"type": "<string>",
"default_value": "<any>",
"secret": true
}
],
"output_fields": [
{
"field": "<string>",
"description": "<string>",
"type": "<string>"
}
],
"disabled": true
}
}