Labels

Labels are the semantic categories that are available for annotations. When creating an annotation, it must be provided with a label that is available from the list that is retrieved via this endpoint.

Supported labels

The API provides a predefined list of supported labels. These labels include:

• Loader - A vehicle used to move or load loose bulk materials such as rock, sand, mulch, or soil. Other names for this vehicle include bucket loader or front-end loader.
• Pallet - A stack of material that is organized on top of a flat, rectangular structure for transportation or storage. For example, in the API, a pallet may refer to bags of mulch stacked on a wooden pallet, or boxed goods that are arranged on a plastic skid.
• Pallets - A group of pallets that are stacked on top of or adjacent to each other. A single pallet of material should use the "pallet" label, but a group of similar pallets that have been arranged and stored together can be collectively annotated as "pallets".
• Railcar - A train car that is used to contain and transport loose bulk materials via rail. Other names for this include a hopper car or railroad freight car.
• Stockpile - A pile of loose bulk material.
• Truck - A vehicle used to transport loose bulk materials via road. Specific examples include haul trucks, dump trucks, and trucks with live bottom trailers.

Get a list of labels

Retrieve the list of available labels that can be used for annotations. Each label in the list is represented by its URI.

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

Sample response body:

{
  "success": true,
  "data": {
    "labels": [
      "/labels/loader",
      "/labels/pallet",
      "/labels/pallets",
      "/labels/railcar",
      "/labels/stockpile",
      "/labels/truck"
    ]
  }
}

Get details of a label

Retrieve the details of an individual label.

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

Sample response body:

{
  "success": true,
  "data": {
    "label": {
      "uri": "/labels/loader",
      "name": "loader",
      "description": "A vehicle used to move or load loose bulk materials."
    }
  }
}