Actions

Actions are the operations that can be performed in response to a trigger.

Supported actions

The API provides a predefined list of supported actions. The current supported actions are:

• Detect Objects - Use a machine learning-based object detector to automatically identify 2D bounding boxes around objects in an image and create new annotations for any objects that are found. The types of objects that can be detected are a subset of the labels that are supported, specifically: loader, railcar, stockpile, and truck. Whenever a new annotation is created as the result of a trigger, a notification will be delivered via the webhook.

Get a list of actions

Retrieve the list of available actions that can be used for triggers. Each action in the list is represented by its URI.

Route: /v3{instance-uri}/actions
Method: GET

Sample response body:

{
  "success": true,
  "data": {
    "actions": [
      "/actions/detect-objects"
    ]
  }
}

Get details of an action

Retrieve the details of an individual action.

Route: /v3{instance-uri}{action-uri}
Method: GET

Sample response body:

{
  "success": true,
  "data": {
    "action": {
      "uri": "/actions/detect-objects",
      "name": "Detect Objects",
      "description": "Perform object detection and create an annotation for any object that is found."
    }
  }
}