Callback Format

Once the videoplaybackannotation task is done, we will send a response to your callback URL. The response.annotations.url field of the callback will be a link to a JSON file containing the annotations, and the response.annotations.events field of the callback will be a link to a JSON file containing the events.

{
  "response": {
    "annotations": {
        "url": "https://scaleapi-results.s3.amazonaws.com/5e5dc4a0-1d9b-11e8-bce8-41122de76216"
    },
    "events": {
        "url": "https://scaleapi-results.s3.amazonaws.com/5e5dc4a0-1d9b-11e8-bce8-41122de76217"
    }
  },
  "task_id": "582bfe0ee5d51cda4e903f4a",
  "task": {
    // populated task for convenience
    ...
  }
}

The annotations file will contain a dictionary of the annotated objects. Each key will be the annotation's unique identifier (uuid) and its value will have the following fields:

label (if with_labels is true): The label for the annotation, which will be one of the specified task.params.geometries.
geometry: The geometry type of the annotation. All geometries (points, lines, boxes, ellipses, cuboids, polygons) are supported.
frames: An array specifying the annotation's values throughout the video.

Each frame will have the following format:

key: The frame number. The frame number (relative to the video). This may not be consecutive if the provided annotation frame rate is less than the video frame rate. If the annotation frame rate does not divide the video frame rate evenly, the closest video frame is annotated. For example if the video frame rate is 29.92 and annotation frame rate is 5, then the first annotation has a key of (1/5 sec) * (29.92 fps) = 5.984 or 6th frame.
attributes: Annotation attributes in this specific frame. The value will contain attributes specified in task.params.annotation_attributes
timestamp: The timestamp of the frame within the video in seconds.
Additional geometry-specific fields - see the docs for points, lines, boxes, cuboids, ellipses, and polygons for more documentation about those fields.

[
  {
    "annotations": {
      "26201bd9-72ab-4b63-ab7d-df4e671161b9": {
        "label": "Person",
        "geometry": "box",
        "frames": [
          {
            "key": 1,
            "left": 854,
            "top": 144,
            "height": 168,
            "width": 72,
            "attributes": {},
            "timestamp": 0.03
          },
          ...
        ]
      }
    }
  }
]