Get sample
Get a sample.
Project ID
Sample ID
Limit the number of payload values in the response
If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
Impulse ID. If this is unset then the default impulse is used.
Pass this parameter when querying samples from inside an AI Action job. If you pass this parameter in a multi-stage AI Action, previous proposed changes (from an earlier step) will be applied to the returned dataset.
If true, only a slice of labels will be returned for samples with multiple labels.
GET /v1/api/{projectId}/raw-data/{sampleId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*
OK
{
"success": true,
"error": "text",
"sample": {
"id": 2,
"filename": "idle01.d8Ae",
"signatureValidate": true,
"signatureMethod": "HS256",
"signatureKey": "text",
"created": "2025-07-06T01:16:19.623Z",
"lastModified": "2025-07-06T01:16:19.623Z",
"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-06T01:16:19.623Z",
"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
}
Last updated
Was this helpful?