Get sample slice

Get sample slice

get

Get a slice of a sample.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

projectIdintegerRequired

Project ID

sampleIdintegerRequired

Sample ID

Query parameters

sliceStartintegerRequired

Begin index of the slice

sliceEndintegerOptional

End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.

impulseIdintegerOptional

Impulse ID. If this is unset then the default impulse is used.

truncateStructuredLabelsbooleanOptional

If true, only a slice of labels will be returned for samples with multiple labels.

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/api/{projectId}/raw-data/{sampleId}/slice HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "error": "text",
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "signatureKey": "text",
    "created": "2025-07-12T02:37:15.591Z",
    "lastModified": "2025-07-12T02:37:15.591Z",
    "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"
      }
    ],
    "valuesCount": 1,
    "totalLengthMs": 1,
    "added": "2025-07-12T02:37:15.591Z",
    "boundingBoxes": [
      {
        "label": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1
      }
    ],
    "boundingBoxesType": "object_detection",
    "chartType": "chart",
    "thumbnailVideo": "text",
    "thumbnailVideoFull": "text",
    "isDisabled": true,
    "isProcessing": true,
    "processingJobId": 1,
    "processingError": true,
    "processingErrorString": "text",
    "isCropped": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "projectId": 1,
    "projectOwnerName": "text",
    "projectName": "text",
    "projectLabelingMethod": "single_label",
    "sha256Hash": "text",
    "structuredLabels": [
      {
        "startIndex": 1,
        "endIndex": 1,
        "label": "text"
      }
    ],
    "structuredLabelsList": [
      "text"
    ],
    "createdBySyntheticDataJobId": 1,
    "imageDimensions": {
      "width": 1,
      "height": 1
    },
    "videoUrl": "text",
    "videoUrlFull": "text"
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        1
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  },
  "totalPayloadLength": 1
}