1 of 61

Rawdata

List samples

Count samples

Object detection label queue

Object detection label queue count

Rebalance dataset

Clear all object detection labels

Remove all samples

Remove all samples by category

Get project sample metadata

Run auto-labeler job

Get auto-labeler results

View auto-labeler segment info

Get auto-labeler image

Save auto-labeler clusters

List data with "imported from" metadata key

Get sample

Remove sample

Download file

Get WAV file

Get image file

Get video file

Get sample slice

Rename sample

Edit label

Move sample

Crop sample

Split sample into frames

Find segments

Segment sample

Set bounding boxes

Update structured labels

Store the last segment length

Get the original downsampled data

Retry processing

Enable sample

Disable sample

Auto-label an image

Set sample metadata

Move sample to labeling queue

Propose changes

Edit labels for multiple samples

Remove multiple samples

Move multiple samples

Enable multiple samples

Disable multiple samples

Add metadata (multiple samples)

Clear metadata by key (multiple samples)

Clear all metadata (multiple samples)

Track objects

Get data explorer features

Check data explorer features

Get data explorer predictions

Clear data explorer

Get data explorer settings

Set data explorer settings

Check if data diversity metrics exist

Get diversity metrics data

Check if label noise metrics exist

Get label noise data

Get AI Actions proposed changes

List samples

Retrieve all raw data by category.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

excludeSensorsboolean

Whether to exclude sensors in the response (as these can slow down requests when you have large pages).

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

searchstring

Search query

Example: "<id> <name>"

proposedActionsJobIdinteger

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.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

samples*array of Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

totalCount*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data?category=training', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2024-11-21T15:45:12.636Z",
      "lastModified": "2024-11-21T15:45:12.636Z",
      "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-11-21T15:45:12.636Z",
      "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"
      ],
      "imageDimensions": {}
    }
  ]
}

Count samples

Count all raw data by category.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/count

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

count*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/count?category=training', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Run auto-labeler job

Run the auto-labeler over all unlabeled data.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/auto-labeler/run

Path parameters

projectId*integer

Project ID

Body

simThreshold*number

minObjectSizePx*integer

maxObjectSizePxinteger

whichItemsToInclude*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/auto-labeler/run', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "simThreshold": 0,
      "whichItemsToInclude": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "id": 12873488112
}

Rebalance dataset

Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/rebalance

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

ratioobject

traininginteger

number of training samples after rebalance

testinginteger

number of testing samples after rebalance

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/rebalance', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "ratio": {}
}

Get project sample metadata

Get metadata for all samples in a project.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/metadata

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

metadata*array of SampleMetadata (object)

Array with all available sample metadata.

id*integer

Sample ID

metadata*object

Sample free form associated metadata

Other propertiesstring

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/metadata?category=training', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "metadata": [
    {}
  ]
}

Get auto-labeler results

Retrieve the results of the auto-labeler (after running StartJobResponse)

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

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasResults*boolean

clusters*array of object

labelstring

items*array of object

sampleId*integer

maskId*integer

imageUrl*string

simThreshold*number

minObjectSizePx*integer

maxObjectSizePxinteger

whichItemsToInclude*string

Request

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

Response

{
  "success": false,
  "error": "text",
  "hasResults": false,
  "clusters": [
    {
      "label": "text",
      "items": [
        {
          "imageUrl": "text"
        }
      ]
    }
  ],
  "simThreshold": 0,
  "whichItemsToInclude": "text"
}

Get sample

Get a sample.

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

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

limitPayloadValuesinteger

Limit the number of payload values in the response

cacheKeystring

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).

impulseIdinteger

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

proposedActionsJobIdinteger

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

payload*RawSamplePayload (object)

Sensor readings and metadata

device_namestring

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example: "ac:87:a3:0a:2d:1b"

device_type*string

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example: "DISCO-L475VG-IOT01A"

sensors*array of Sensor (object)

Array with sensor axes

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

values*array of array of number

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

itemsnumber

cropStartinteger

New start index of the cropped sample

Example: 0

cropEndinteger

New end index of the cropped sample

Example: 128

totalPayloadLength*integer

Total number of payload values

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}', {
    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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        0
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  }
}

List data with "imported from" metadata key

Lists all data with an 'imported from' metadata key. Used to check in a data source which items are already in a project.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/imported-from

Path parameters

projectId*integer

Project ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

data*array of object

id*integer

category*string

importedFrom*string

Request

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

Response

{
  "success": false,
  "error": "text",
  "data": [
    {
      "category": "text",
      "importedFrom": "text"
    }
  ]
}

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

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

imageUrl*string

segments*array of AutoLabelerSegment (object)

id*integer

maskUrl*string

maskX*integer

maskY*integer

maskWidth*integer

maskHeight*integer

cluster*integer

Request

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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "imageUrl": "text",
  "segments": [
    {
      "maskUrl": "text"
    }
  ]
}

Get image file

Get a sample as an image file. This only applies to samples with RGBA data.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/image

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

afterInputBlockboolean

Whether to process the image through the input block first

cacheKeystring

impulseIdinteger

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

Response

Image file (either JPEG or PNG format)

Body

string (binary)

Request

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

Response

binary

Get WAV file

Get a sample as a WAV file. This only applies to samples with an audio axis.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/wav

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

axisIx*integer

Axis index

sliceStartinteger

Begin index of the slice. If not given, the whole sample is used.

sliceEndinteger

End index of the slice. If not given, the whole sample is used.

cacheKeystring

Response

Wav file

Body

string (binary)

Request

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

Response

binary

Edit label

Sets the label (also known as class) of the sample. Use the same label for similar types of data, as they are used during training.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/edit-label

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

labelstring

New label for this sample

Example: "water-hammer"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/edit-label', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Crop sample

Crop a sample to within a new range.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/crop

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

cropStart*integer

New start index of the sample

Example: 0

cropEnd*integer

New end index of the sample

Example: 128

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

requiresProcessing*boolean

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/crop', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cropStart": 0,
      "cropEnd": 128
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "requiresProcessing": false
}

Get video file

Get a sample as an video file. This only applies to samples with video data.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/video

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

afterInputBlockboolean

Whether to process the image through the input block first

cacheKeystring

impulseIdinteger

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

Response

Video file in AVI or MP4 format

Body

string (binary)

Request

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

Response

binary

Update structured labels

Set structured labels for a sample. If a sample has structured labels the label column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see valuesCount to get the upper bound). endIndex is inclusive. If you pass in an incorrect array (e.g. missing values) you'll get an error back.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/structured-labels

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

structuredLabels*array of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/structured-labels', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "structuredLabels": [
        {
          "label": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Rename sample

Sets the file name of the sample. This name does not need to be unique, but it's highly recommended to do so.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/rename

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

name*string

New name for this sample

Example: "faulty-machine2.A3de"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/rename', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "faulty-machine2.A3de"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Get the original downsampled data

Get the original, uncropped, downsampled data.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/original

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

limitPayloadValuesinteger

Limit the number of payload values in the response

zoomStartinteger

Zoom into the sample, with the focus starting at this index

zoomEndinteger

Zoom into the sample, with the focus ending at this index

impulseIdinteger

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

payload*RawSamplePayload (object)

Sensor readings and metadata

device_namestring

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example: "ac:87:a3:0a:2d:1b"

device_type*string

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example: "DISCO-L475VG-IOT01A"

sensors*array of Sensor (object)

Array with sensor axes

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

values*array of array of number

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

itemsnumber

cropStartinteger

New start index of the cropped sample

Example: 0

cropEndinteger

New end index of the cropped sample

Example: 128

totalPayloadLength*integer

Total number of payload values

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/original', {
    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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        0
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  }
}

Get sample slice

Get a slice of a sample.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/slice

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

sliceStart*integer

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.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

payload*RawSamplePayload (object)

Sensor readings and metadata

device_namestring

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example: "ac:87:a3:0a:2d:1b"

device_type*string

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example: "DISCO-L475VG-IOT01A"

sensors*array of Sensor (object)

Array with sensor axes

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

values*array of array of number

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

itemsnumber

cropStartinteger

New start index of the cropped sample

Example: 0

cropEndinteger

New end index of the cropped sample

Example: 128

totalPayloadLength*integer

Total number of payload values

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/slice', {
    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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        0
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  }
}

Auto-label an image

Classify an image using another neural network.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/autolabel

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

neuralNetwork*enum

yolov5currentProject

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

results*array of object

label*string

x*integer

y*integer

width*integer

height*integer

allLabels*array of string

itemsstring

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/autolabel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "neuralNetwork": "yolov5"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "results": [
    {
      "label": "text"
    }
  ],
  "allLabels": [
    "text"
  ]
}

Edit labels for multiple samples

Sets the label (also known as class) of multiple samples. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/edit-labels

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

labelstring

New label for this sample

Example: "water-hammer"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/edit-labels?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Store the last segment length

When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/store-segment-length

Path parameters

projectId*integer

Project ID

Body

segmentLength*number

Last segment length in milliseconds.

Example: 1000

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/store-segment-length', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "segmentLength": 1000
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Move multiple samples

Move multiple samples to another category (e.g. from test to training). Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/moveSamples

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

newCategory*enum

trainingtestinganomaly

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/moveSamples?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "newCategory": "training"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Find segments

Find start and end times for all non-noise events in a sample

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/find-segments

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

shiftSegments*boolean

If set, the segments are automatically shifted randomly, to make the dataset distribution more uniform.

segmentLengthMs*integer

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

segments*array of object

startMs*integer

endMs*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/find-segments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "shiftSegments": false
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "segments": [
    {}
  ]
}

Propose changes

Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

jobId*integer

Job ID of an AI Actions job. This is passed into your job via the --propose-actions argument.

proposedChanges*SampleProposedChanges (object)

labelstring

New label (single-label)

isDisabledboolean

True if the current sample should be disabled; or false if it should not be disabled.

boundingBoxesarray of BoundingBox (object)

List of bounding boxes. The existing bounding boxes on the sample will be replaced (so if you want to add new bounding boxes, use the existing list as a basis).

label*string

x*integer

y*integer

width*integer

height*integer

metadataobject

Free form associated metadata. The existing metadata on the sample will be replaced (so if you want to add new metadata, use the existing list as a basis).

Other propertiesstring

structuredLabelsarray of StructuredLabel (object)

New label (multi-label)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "proposedChanges": {}
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Enable multiple samples

Enables samples, ensuring that they are not excluded from the dataset. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/enable-samples

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/enable-samples?category=training', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Add metadata (multiple samples)

Add specific metadata for multiple samples.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/add-metadata

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

metadataKey*string

metadataValue*string

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/add-metadata?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "metadataKey": "text",
      "metadataValue": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Disable multiple samples

Disables samples, ensuring that they are excluded from the dataset. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/disable-samples

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/disable-samples?category=training', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Remove multiple samples

Deletes samples. Note that this does not delete the data from cold storage. Depending on the number of affected samples this will either execute immediately or return the ID of a job that will perform this action in batches.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/delete

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/delete?category=training', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Clear metadata by key (multiple samples)

Clears a specific metadata field (by key) for multiple samples.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata-by-key

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

metadataKey*string

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata-by-key?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "metadataKey": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Get video file

Get a sample as an video file. This only applies to samples with video data.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/video

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

afterInputBlockboolean

Whether to process the image through the input block first

cacheKeystring

impulseIdinteger

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

Response

Video file in AVI or MP4 format

Body

string (binary)

Request

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

Response

binary

Get image file

Get a sample as an image file. This only applies to samples with RGBA data.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/image

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

afterInputBlockboolean

Whether to process the image through the input block first

cacheKeystring

impulseIdinteger

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

Response

Image file (either JPEG or PNG format)

Body

string (binary)

Request

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

Response

binary

Get WAV file

Get a sample as a WAV file. This only applies to samples with an audio axis.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/wav

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

axisIx*integer

Axis index

sliceStartinteger

Begin index of the slice. If not given, the whole sample is used.

sliceEndinteger

End index of the slice. If not given, the whole sample is used.

cacheKeystring

Response

Wav file

Body

string (binary)

Request

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

Response

binary

Get sample

Get a sample.

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

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

limitPayloadValuesinteger

Limit the number of payload values in the response

cacheKeystring

impulseIdinteger

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

proposedActionsJobIdinteger

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

payload*RawSamplePayload (object)

Sensor readings and metadata

device_namestring

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example: "ac:87:a3:0a:2d:1b"

device_type*string

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example: "DISCO-L475VG-IOT01A"

sensors*array of Sensor (object)

Array with sensor axes

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

values*array of array of number

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

itemsnumber

cropStartinteger

New start index of the cropped sample

Example: 0

cropEndinteger

New end index of the cropped sample

Example: 128

totalPayloadLength*integer

Total number of payload values

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}', {
    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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        0
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  }
}

Get sample slice

Get a slice of a sample.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/slice

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

sliceStart*integer

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.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

payload*RawSamplePayload (object)

Sensor readings and metadata

device_namestring

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example: "ac:87:a3:0a:2d:1b"

device_type*string

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example: "DISCO-L475VG-IOT01A"

sensors*array of Sensor (object)

Array with sensor axes

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

values*array of array of number

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

itemsnumber

cropStartinteger

New start index of the cropped sample

Example: 0

cropEndinteger

New end index of the cropped sample

Example: 128

totalPayloadLength*integer

Total number of payload values

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/slice', {
    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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        0
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  }
}

Edit label

Sets the label (also known as class) of the sample. Use the same label for similar types of data, as they are used during training.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/edit-label

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

labelstring

New label for this sample

Example: "water-hammer"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/edit-label', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Disable multiple samples

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/disable-samples

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/disable-samples?category=training', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Remove multiple samples

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/delete

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/delete?category=training', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Rename sample

Sets the file name of the sample. This name does not need to be unique, but it's highly recommended to do so.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/rename

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

name*string

New name for this sample

Example: "faulty-machine2.A3de"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/rename', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "faulty-machine2.A3de"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Store the last segment length

When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/store-segment-length

Path parameters

projectId*integer

Project ID

Body

segmentLength*number

Last segment length in milliseconds.

Example: 1000

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/store-segment-length', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "segmentLength": 1000
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Run auto-labeler job

Run the auto-labeler over all unlabeled data.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/auto-labeler/run

Path parameters

projectId*integer

Project ID

Body

simThreshold*number

minObjectSizePx*integer

maxObjectSizePxinteger

whichItemsToInclude*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/auto-labeler/run', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "simThreshold": 0,
      "whichItemsToInclude": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "id": 12873488112
}

Rebalance dataset

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/rebalance

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

ratioobject

traininginteger

number of training samples after rebalance

testinginteger

number of testing samples after rebalance

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/rebalance', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "ratio": {}
}

List data with "imported from" metadata key

Lists all data with an 'imported from' metadata key. Used to check in a data source which items are already in a project.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/imported-from

Path parameters

projectId*integer

Project ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

data*array of object

id*integer

category*string

importedFrom*string

Request

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

Response

{
  "success": false,
  "error": "text",
  "data": [
    {
      "category": "text",
      "importedFrom": "text"
    }
  ]
}

Clear metadata by key (multiple samples)

Clears a specific metadata field (by key) for multiple samples.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata-by-key

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

metadataKey*string

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata-by-key?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "metadataKey": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Edit labels for multiple samples

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/edit-labels

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

labelstring

New label for this sample

Example: "water-hammer"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/edit-labels?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Add metadata (multiple samples)

Add specific metadata for multiple samples.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/add-metadata

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

metadataKey*string

metadataValue*string

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/add-metadata?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "metadataKey": "text",
      "metadataValue": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Move multiple samples

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/moveSamples

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Body

newCategory*enum

trainingtestinganomaly

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/moveSamples?category=training', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "newCategory": "training"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Count samples

Count all raw data by category.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/count

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

count*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/count?category=training', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Enable multiple samples

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/enable-samples

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

any of

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/enable-samples?category=training', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Crop sample

Crop a sample to within a new range.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/crop

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

cropStart*integer

New start index of the sample

Example: 0

cropEnd*integer

New end index of the sample

Example: 128

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

requiresProcessing*boolean

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/crop', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cropStart": 0,
      "cropEnd": 128
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "requiresProcessing": false
}

Get auto-labeler results

Retrieve the results of the auto-labeler (after running StartJobResponse)

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

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasResults*boolean

clusters*array of object

labelstring

items*array of object

sampleId*integer

maskId*integer

imageUrl*string

simThreshold*number

minObjectSizePx*integer

maxObjectSizePxinteger

whichItemsToInclude*string

Request

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

Response

{
  "success": false,
  "error": "text",
  "hasResults": false,
  "clusters": [
    {
      "label": "text",
      "items": [
        {
          "imageUrl": "text"
        }
      ]
    }
  ],
  "simThreshold": 0,
  "whichItemsToInclude": "text"
}

Find segments

Find start and end times for all non-noise events in a sample

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/find-segments

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

shiftSegments*boolean

If set, the segments are automatically shifted randomly, to make the dataset distribution more uniform.

segmentLengthMs*integer

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

segments*array of object

startMs*integer

endMs*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/find-segments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "shiftSegments": false
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "segments": [
    {}
  ]
}

Update structured labels

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/structured-labels

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

structuredLabels*array of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/structured-labels', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "structuredLabels": [
        {
          "label": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Get project sample metadata

Get metadata for all samples in a project.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/metadata

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

metadata*array of SampleMetadata (object)

Array with all available sample metadata.

id*integer

Sample ID

metadata*object

Sample free form associated metadata

Other propertiesstring

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/metadata?category=training', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "metadata": [
    {}
  ]
}

Auto-label an image

Classify an image using another neural network.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/autolabel

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

neuralNetwork*enum

yolov5currentProject

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

results*array of object

label*string

x*integer

y*integer

width*integer

height*integer

allLabels*array of string

itemsstring

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/autolabel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "neuralNetwork": "yolov5"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "results": [
    {
      "label": "text"
    }
  ],
  "allLabels": [
    "text"
  ]
}

Propose changes

Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Body

jobId*integer

Job ID of an AI Actions job. This is passed into your job via the --propose-actions argument.

proposedChanges*SampleProposedChanges (object)

labelstring

New label (single-label)

isDisabledboolean

True if the current sample should be disabled; or false if it should not be disabled.

boundingBoxesarray of BoundingBox (object)

List of bounding boxes. The existing bounding boxes on the sample will be replaced (so if you want to add new bounding boxes, use the existing list as a basis).

label*string

x*integer

y*integer

width*integer

height*integer

metadataobject

Free form associated metadata. The existing metadata on the sample will be replaced (so if you want to add new metadata, use the existing list as a basis).

Other propertiesstring

structuredLabelsarray of StructuredLabel (object)

New label (multi-label)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "proposedChanges": {}
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

List samples

Retrieve all raw data by category.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

excludeSensorsboolean

Whether to exclude sensors in the response (as these can slow down requests when you have large pages).

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

searchstring

Search query

Example: "<id> <name>"

proposedActionsJobIdinteger

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

samples*array of Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

totalCount*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data?category=training', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2024-11-21T15:45:12.636Z",
      "lastModified": "2024-11-21T15:45:12.636Z",
      "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-11-21T15:45:12.636Z",
      "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"
      ],
      "imageDimensions": {}
    }
  ]
}

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

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

imageUrl*string

segments*array of AutoLabelerSegment (object)

id*integer

maskUrl*string

maskX*integer

maskY*integer

maskWidth*integer

maskHeight*integer

cluster*integer

Request

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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "imageUrl": "text",
  "segments": [
    {
      "maskUrl": "text"
    }
  ]
}

Get the original downsampled data

Get the original, uncropped, downsampled data.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/original

Path parameters

projectId*integer

Project ID

sampleId*integer

Sample ID

Query parameters

limitPayloadValuesinteger

Limit the number of payload values in the response

zoomStartinteger

Zoom into the sample, with the focus starting at this index

zoomEndinteger

Zoom into the sample, with the focus ending at this index

impulseIdinteger

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

sample*Sample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

payload*RawSamplePayload (object)

Sensor readings and metadata

device_namestring

Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).

Example: "ac:87:a3:0a:2d:1b"

device_type*string

Device type, for example the exact model of the device. Should be the same for all similar devices.

Example: "DISCO-L475VG-IOT01A"

sensors*array of Sensor (object)

Array with sensor axes

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

values*array of array of number

Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.

itemsnumber

cropStartinteger

New start index of the cropped sample

Example: 0

cropEndinteger

New end index of the cropped sample

Example: 128

totalPayloadLength*integer

Total number of payload values

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/original', {
    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-11-21T15:45:12.636Z",
    "lastModified": "2024-11-21T15:45:12.636Z",
    "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-11-21T15:45:12.636Z",
    "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"
    ],
    "imageDimensions": {}
  },
  "payload": {
    "device_name": "ac:87:a3:0a:2d:1b",
    "device_type": "DISCO-L475VG-IOT01A",
    "sensors": [
      {
        "name": "accX",
        "units": "text"
      }
    ],
    "values": [
      [
        0
      ]
    ],
    "cropStart": 0,
    "cropEnd": 128
  }
}

Clear all metadata (multiple samples)

Clears all metadata for multiple samples.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Check data explorer features

t-SNE2 output of the raw dataset

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-explorer/has-features

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

inputBlockImpulseInputBlock (object)

id*integer

Identifier for this block. Make sure to up this number when creating a new block, and don't re-use identifiers. If the block hasn't changed, keep the ID as-is. ID must be unique across the project and greather than zero (>0).

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Get data explorer features

t-SNE2 output of the raw dataset

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-explorer/features

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

data*array of object

X*object

Data by feature index for this window

Example: "`{ 0: 9.81, 11: 0.32, 22: 0.79 }`"

Other propertiesnumber

y*integer

Training label index

yLabel*string

Training label string

sampleobject

id*number

name*string

startMs*number

endMs*number

category*enum

trainingtesting

inputBlockImpulseInputBlock (object)

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Get AI Actions proposed changes

Get proposed changes from an AI Actions job.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes

Path parameters

projectId*integer

Project ID

jobId*integer

Job ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

proposedChanges*array of object

sampleId*integer

step*integer

proposedChanges*SampleProposedChanges (object)

labelstring

New label (single-label)

isDisabledboolean

True if the current sample should be disabled; or false if it should not be disabled.

boundingBoxesarray of BoundingBox (object)

List of bounding boxes. The existing bounding boxes on the sample will be replaced (so if you want to add new bounding boxes, use the existing list as a basis).

label*string

x*integer

y*integer

width*integer

height*integer

metadataobject

Free form associated metadata. The existing metadata on the sample will be replaced (so if you want to add new metadata, use the existing list as a basis).

Other propertiesstring

structuredLabelsarray of StructuredLabel (object)

New label (multi-label)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

Request

Response

Get diversity metrics data

Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/diversity

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dataarray of object

labelIdnumber

maxDistance*number

clusterInfos*array of object

idx*integer

Unique index of the cluster

indexes*array of integer

Indexes of all windows contained in the cluster (for debugging)

itemsinteger

windows*array of array of integer

The sample ID and window start and end of every window in the cluster

itemsinteger

samplesarray of Sample (object)

Details of every sample in the cluster

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

vendiScore*number

Raw vendi score

vendiRatio*number

Vendi score expressed as ratio from 0 to 1

count*integer

The number if windows in the cluster

distance*number

The distance of the cluster from the origin

leftIdx*nullable integer

The cluster id on the left branch of the dendrogram

rightIdx*nullable integer

The cluster id on the right branch of the dendrogram

Request

Response

Check if data diversity metrics exist

Determine if data diversity metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/diversity/exists

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

inputBlockImpulseInputBlock (object)

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Get label noise data

Obtain metrics that describe potential label noise issues in the dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/label-noise

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

data*object

cosineSimilarityCosineSimilarityData (object)

Describes the results of running the cosine similarity label noise detection method.

similarButDifferentLabel*array of CosineSimilarityIssue (object)

A list of samples that have windows that are similar to windows of other samples that have a different label.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

issues*array of object

A list of samples that have windows that are symptomatic of this issue.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

windows*array of object

The windows in this sample that are symptomatic of this issue.

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

score*number

The cosine similarity score between this window and a window from the sample in the parent object.

differentButSameLabel*array of CosineSimilarityIssue (object)

A list of samples that have windows that are dissimilar to windows of other samples that have the same label.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

issues*array of object

A list of samples that have windows that are symptomatic of this issue.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

windows*array of object

The windows in this sample that are symptomatic of this issue.

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

score*number

The cosine similarity score between this window and a window from the sample in the parent object.

neighborsNeighborsData (object)

Describes the results of running the nearest neighbors label noise detection method.

scoresAndNeighbors*array of NeighborsScore (object)

The label noise score and nearest neighbors for each window of data in the project that shows a potential label noise issue.

id*integer

The ID of the sample this window belongs to

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

score*number

The label noise score for this window, from 0 to the total number of windows.

neighborWindows*array of object

Details of the nearest neighbors to this window

id*integer

The ID of the sample this window belongs to

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

numNeighbors*integer

The number of neighbors used in the nearest neighbors algorithm.

crossValidationCrossValidationData (object)

Describes the results of running the cross validation label noise detection method.

scores*array of object

id*integer

The ID of the sample this window belongs to

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

label*integer

The label of this window, in index form

probability*number

The probability of this window being the label it was assigned, as estimated by a classifier trained on the whole dataset.

score*number

The z-score of the probability with respect to other class members, so that outliers (i.e. windows whose probability is low) can be easily spotted. This assumes that most correctly labelled class members will have a high probability.

Request

Response

Check if label noise metrics exist

Determine if label noise metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/label-noise/exists

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

inputBlockImpulseInputBlock (object)

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Check if data diversity metrics exist

Determine if data diversity metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/diversity/exists

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

inputBlockImpulseInputBlock (object)

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Check if label noise metrics exist

Determine if label noise metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/label-noise/exists

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

inputBlockImpulseInputBlock (object)

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Clear all metadata (multiple samples)

Clears all metadata for multiple samples.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata

Path parameters

projectId*integer

Project ID

Query parameters

category*enum

Which of the three acquisition categories to retrieve data from

trainingtestinganomaly

labelsstring

Only include samples with a label within the given list of labels, given as a JSON string

Example: "[\"idle\", \"snake\"]"

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumber

Only include samples with lower frequency than given frequency, in hertz

signatureValidityenum

Include samples with either valid or invalid signatures

bothvalidinvalid

includeDisabledenum

Include only enabled or disabled samples (or both)

bothenableddisabled

idsstring

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: "[1, 2, 3]"

excludeIdsstring

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: "[4, 5, 6]"

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Get AI Actions proposed changes

Get proposed changes from an AI Actions job.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes

Path parameters

projectId*integer

Project ID

jobId*integer

Job ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

proposedChanges*array of object

sampleId*integer

step*integer

proposedChanges*SampleProposedChanges (object)

labelstring

New label (single-label)

isDisabledboolean

True if the current sample should be disabled; or false if it should not be disabled.

boundingBoxesarray of BoundingBox (object)

List of bounding boxes. The existing bounding boxes on the sample will be replaced (so if you want to add new bounding boxes, use the existing list as a basis).

label*string

x*integer

y*integer

width*integer

height*integer

metadataobject

Free form associated metadata. The existing metadata on the sample will be replaced (so if you want to add new metadata, use the existing list as a basis).

Other propertiesstring

structuredLabelsarray of StructuredLabel (object)

New label (multi-label)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

Request

Response

Check data explorer features

t-SNE2 output of the raw dataset

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-explorer/has-features

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

inputBlockImpulseInputBlock (object)

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Get data explorer features

t-SNE2 output of the raw dataset

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-explorer/features

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasFeatures*boolean

data*array of object

X*object

Data by feature index for this window

Example: "`{ 0: 9.81, 11: 0.32, 22: 0.79 }`"

Other propertiesnumber

y*integer

Training label index

yLabel*string

Training label string

sampleobject

id*number

name*string

startMs*number

endMs*number

category*enum

trainingtesting

inputBlockImpulseInputBlock (object)

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

Request

Response

Get diversity metrics data

Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/diversity

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dataarray of object

labelIdnumber

maxDistance*number

clusterInfos*array of object

idx*integer

Unique index of the cluster

indexes*array of integer

Indexes of all windows contained in the cluster (for debugging)

itemsinteger

windows*array of array of integer

The sample ID and window start and end of every window in the cluster

itemsinteger

samplesarray of Sample (object)

Details of every sample in the cluster

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

vendiScore*number

Raw vendi score

vendiRatio*number

Vendi score expressed as ratio from 0 to 1

count*integer

The number if windows in the cluster

distance*number

The distance of the cluster from the origin

leftIdx*nullable integer

The cluster id on the left branch of the dendrogram

rightIdx*nullable integer

The cluster id on the right branch of the dendrogram

Request

Response

Get label noise data

Obtain metrics that describe potential label noise issues in the dataset. To calculate these metrics, use the calculateDataQualityMetrics endpoint.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/data-quality/label-noise

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

data*object

cosineSimilarityCosineSimilarityData (object)

Describes the results of running the cosine similarity label noise detection method.

similarButDifferentLabel*array of CosineSimilarityIssue (object)

A list of samples that have windows that are similar to windows of other samples that have a different label.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

issues*array of object

A list of samples that have windows that are symptomatic of this issue.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

windows*array of object

The windows in this sample that are symptomatic of this issue.

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

score*number

The cosine similarity score between this window and a window from the sample in the parent object.

differentButSameLabel*array of CosineSimilarityIssue (object)

A list of samples that have windows that are dissimilar to windows of other samples that have the same label.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

issues*array of object

A list of samples that have windows that are symptomatic of this issue.

id*integer

The ID of this sample

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

label*integer

The label of this sample, in index form

windows*array of object

The windows in this sample that are symptomatic of this issue.

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

score*number

The cosine similarity score between this window and a window from the sample in the parent object.

neighborsNeighborsData (object)

Describes the results of running the nearest neighbors label noise detection method.

scoresAndNeighbors*array of NeighborsScore (object)

The label noise score and nearest neighbors for each window of data in the project that shows a potential label noise issue.

id*integer

The ID of the sample this window belongs to

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

score*number

The label noise score for this window, from 0 to the total number of windows.

neighborWindows*array of object

Details of the nearest neighbors to this window

id*integer

The ID of the sample this window belongs to

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

numNeighbors*integer

The number of neighbors used in the nearest neighbors algorithm.

crossValidationCrossValidationData (object)

Describes the results of running the cross validation label noise detection method.

scores*array of object

id*integer

The ID of the sample this window belongs to

sampleSample (object)

id*integer

Example: 2

filename*string

Example: "idle01.d8Ae"

signatureValidate*boolean

Whether signature validation passed

Example: true

signatureMethodstring

Example: "HS256"

signatureKeystring

Either the shared key or the public key that was used to validate the sample

created*string (date-time)

Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.

lastModified*string (date-time)

Timestamp when the sample was last modified.

category*string

Example: "training"

coldstorageFilename*string

label*string

Example: "healthy-machine"

intervalMs*number

Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.

Example: 16

frequency*number

Frequency of the sample. If the data was resampled, then this lists the resampled frequency.

Example: 62.5

originalIntervalMs*number

Interval between two windows (1000 / frequency) in the source data (before resampling).

Example: 16

originalFrequency*number

Frequency of the sample in the source data (before resampling).

Example: 62.5

deviceNamestring

deviceType*string

sensors*array of Sensor (object)

name*string

Name of the axis

Example: "accX"

units*string

Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).

valuesCount*integer

Number of readings in this file

totalLengthMsnumber

Total length (in ms.) of this file

added*string (date-time)

Timestamp when the sample was added to the current acquisition bucket.

boundingBoxes*array of BoundingBox (object)

label*string

x*integer

y*integer

width*integer

height*integer

boundingBoxesType*enum

object_detectionconstrained_object_detection

chartType*enum

chartimagevideotable

thumbnailVideostring

thumbnailVideoFullstring

isDisabled*boolean

True if the current sample is excluded from use

isProcessing*boolean

True if the current sample is still processing (e.g. for video)

processingJobIdinteger

Set when sample is processing and a job has picked up the request

processingError*boolean

Set when processing this sample failed

processingErrorStringstring

Error (only set when processing this sample failed)

isCropped*boolean

Whether the sample is cropped from another sample (and has crop start / end info)

metadataobject

Sample free form associated metadata

Other propertiesstring

projectId*integer

Unique identifier of the project this sample belongs to

projectOwnerNamestring

Name of the owner of the project this sample belongs to

projectNamestring

Name of the project this sample belongs to

projectLabelingMethodenum

What labeling flow the project this sample belongs to uses

single_labelobject_detection

sha256Hash*string

Data sample SHA 256 hash (including CBOR envelope if applicable)

structuredLabelsarray of StructuredLabel (object)

startIndex*integer

Start index of the label (e.g. 0)

endIndex*integer

End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.

label*string

The label for this section.

structuredLabelsListarray of string

itemsstring

createdBySyntheticDataJobIdinteger

If this sample was created by a synthetic data job, it's referenced here.

imageDimensionsobject

width*integer

height*integer

windowStart*integer

The start time of this window in milliseconds

windowEnd*integer

The end time of this window in milliseconds

label*integer

The label of this window, in index form

probability*number

The probability of this window being the label it was assigned, as estimated by a classifier trained on the whole dataset.

score*number

Request

Response

{
  "success": false,
  "error": "text",
  "data": {
    "cosineSimilarity": {
      "similarButDifferentLabel": [
        {
          "sample": {
            "id": 2,
            "filename": "idle01.d8Ae",
            "signatureValidate": true,
            "signatureMethod": "HS256",
            "signatureKey": "text",
            "created": "2024-11-21T15:45:12.636Z",
            "lastModified": "2024-11-21T15:45:12.636Z",
            "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-11-21T15:45:12.636Z",
            "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"
            ],
            "imageDimensions": {}
          },
          "issues": [
            {
              "sample": {
                "id": 2,
                "filename": "idle01.d8Ae",
                "signatureValidate": true,
                "signatureMethod": "HS256",
                "signatureKey": "text",
                "created": "2024-11-21T15:45:12.636Z",
                "lastModified": "2024-11-21T15:45:12.636Z",
                "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-11-21T15:45:12.636Z",
                "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"
                ],
                "imageDimensions": {}
              },
              "windows": [
                {
                  "score": 0
                }
              ]
            }
          ]
        }
      ],
      "differentButSameLabel": [
        {
          "sample": {
            "id": 2,
            "filename": "idle01.d8Ae",
            "signatureValidate": true,
            "signatureMethod": "HS256",
            "signatureKey": "text",
            "created": "2024-11-21T15:45:12.636Z",
            "lastModified": "2024-11-21T15:45:12.636Z",
            "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-11-21T15:45:12.636Z",
            "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"
            ],
            "imageDimensions": {}
          },
          "issues": [
            {
              "sample": {
                "id": 2,
                "filename": "idle01.d8Ae",
                "signatureValidate": true,
                "signatureMethod": "HS256",
                "signatureKey": "text",
                "created": "2024-11-21T15:45:12.636Z",
                "lastModified": "2024-11-21T15:45:12.636Z",
                "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-11-21T15:45:12.636Z",
                "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"
                ],
                "imageDimensions": {}
              },
              "windows": [
                {
                  "score": 0
                }
              ]
            }
          ]
        }
      ]
    },
    "neighbors": {
      "scoresAndNeighbors": [
        {
          "sample": {
            "id": 2,
            "filename": "idle01.d8Ae",
            "signatureValidate": true,
            "signatureMethod": "HS256",
            "signatureKey": "text",
            "created": "2024-11-21T15:45:12.636Z",
            "lastModified": "2024-11-21T15:45:12.636Z",
            "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-11-21T15:45:12.636Z",
            "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"
            ],
            "imageDimensions": {}
          },
          "score": 0,
          "neighborWindows": [
            {
              "sample": {
                "id": 2,
                "filename": "idle01.d8Ae",
                "signatureValidate": true,
                "signatureMethod": "HS256",
                "signatureKey": "text",
                "created": "2024-11-21T15:45:12.636Z",
                "lastModified": "2024-11-21T15:45:12.636Z",
                "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-11-21T15:45:12.636Z",
                "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"
                ],
                "imageDimensions": {}
              }
            }
          ]
        }
      ]
    },
    "crossValidation": {
      "scores": [
        {
          "sample": {
            "id": 2,
            "filename": "idle01.d8Ae",
            "signatureValidate": true,
            "signatureMethod": "HS256",
            "signatureKey": "text",
            "created": "2024-11-21T15:45:12.636Z",
            "lastModified": "2024-11-21T15:45:12.636Z",
            "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-11-21T15:45:12.636Z",
            "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"
            ],
            "imageDimensions": {}
          },
          "probability": 0,
          "score": 0
        }
      ]
    }
  }
}