Get sample slice

Get sample slice

Get a slice of a sample.

get

/api/{projectId}/raw-data/{sampleId}/slice

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

sampleIdintegerrequired

Sample ID

Query parameters

sliceStartintegerrequired

Begin index of the slice

sliceEndinteger

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

impulseIdinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/slice?sliceStart=1' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "sample": {
    "id": 2,
    "filename": "idle01.d8Ae",
    "signatureValidate": true,
    "signatureMethod": "HS256",
    "signatureKey": "text",
    "created": "2025-02-22T08:25:50.835Z",
    "lastModified": "2025-02-22T08:25:50.835Z",
    "category": "training",
    "coldstorageFilename": "text",
    "label": "healthy-machine",
    "intervalMs": 16,
    "frequency": 62.5,
    "originalIntervalMs": 16,
    "originalFrequency": 62.5,
    "deviceName": "text",
    "deviceType": "text",
    "valuesCount": 1,
    "totalLengthMs": 1,
    "added": "2025-02-22T08:25:50.835Z",
    "thumbnailVideo": "text",
    "thumbnailVideoFull": "text",
    "isDisabled": true,
    "isProcessing": true,
    "processingJobId": 1,
    "processingError": true,
    "processingErrorString": "text",
    "isCropped": true,
    "projectId": 1,
    "projectOwnerName": "text",
    "projectName": "text",
    "sha256Hash": "text",
    "createdBySyntheticDataJobId": 1,
    "boundingBoxesType": "object_detection",
    "chartType": "chart",
    "projectLabelingMethod": "single_label",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "boundingBoxes": [
      {
        "label": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1
      }
    ],
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "structuredLabels": [
      {
        "startIndex": 1,
        "endIndex": 1,
        "label": "text"
      }
    ],
    "structuredLabelsList": [
      "text"
    ],
    "imageDimensions": {
      "width": 1,
      "height": 1
    }
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "cropStart": 0,
    "cropEnd": 128,
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        1
      ]
    ]
  },
  "totalPayloadLength": 1
}

OK