View auto-labeler segment info

View auto-labeler segment info

Get info from a specific segment in an image. Pass in both sampleId and segmentId in the URL.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/auto-labeler/samples/{sampleId}/segments

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

sample*Sample (object)

imageUrl*string

segments*array of AutoLabelerSegment (object)

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/auto-labeler/samples/{sampleId}/segments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "signatureKey": "text",
    "created": "2024-07-04T18:03:58.932Z",
    "lastModified": "2024-07-04T18:03:58.932Z",
    "category": "training",
    "coldstorageFilename": "text",
    "label": "healthy-machine",
    "intervalMs": 16,
    "frequency": 62.5,
    "originalIntervalMs": 16,
    "originalFrequency": 62.5,
    "deviceName": "text",
    "deviceType": "text",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "totalLengthMs": 0,
    "added": "2024-07-04T18:03:58.932Z",
    "boundingBoxes": [
      {
        "label": "text"
      }
    ],
    "boundingBoxesType": "object_detection",
    "chartType": "chart",
    "thumbnailVideo": "text",
    "thumbnailVideoFull": "text",
    "isDisabled": false,
    "isProcessing": false,
    "processingError": false,
    "processingErrorString": "text",
    "isCropped": false,
    "projectOwnerName": "text",
    "projectName": "text",
    "projectLabelingMethod": "single_label",
    "sha256Hash": "text",
    "structuredLabels": [
      {
        "label": "text"
      }
    ],
    "structuredLabelsList": [
      "text"
    ]
  },
  "imageUrl": "text",
  "segments": [
    {
      "maskUrl": "text"
    }
  ]
}