Preview samples for AI Actions

Preview samples for AI Actions

Get a number of random samples to show in the AI Actions screen. If saveConfig is passed in, then a valid actionId is required in the URL. If you don't need to save the config (e.g. when creating a new action), you can use -1.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/ai-actions/{actionId}/preview-samples

Path parameters

projectId*integer

Project ID

actionId*integer

AI Action ID

Body

application/json

saveConfig*boolean

If this is passed in, the previewConfig of the AI action is overwritten (requires actionId to be a valid action).

dataCategory*AIActionsDataCategory (enum)

allDataunlabeledDatadataWithoutMetadataKeydataWithMetadata

dataMetadataKeystring

Metadata key to filter on. Required if dataCategory is equal to "dataWithoutMetadataKey" or "dataWithMetadata".

dataMetadataValuestring

Metadata value to filter on. Required if dataCategory is equal to "dataWithMetadata".

maxDataPreviewCount*integer

Max. amount of data items to return.

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

samples*array of Sample (object)

totalCount*integer

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/ai-actions/{actionId}/preview-samples', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "saveConfig": false,
      "dataCategory": "allData",
      "maxDataPreviewCount": 0
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "text",
      "created": "2024-12-21T14:30:09.041Z",
      "lastModified": "2024-12-21T14:30:09.041Z",
      "category": "training",
      "coldstorageFilename": "text",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "deviceName": "text",
      "deviceType": "text",
      "sensors": [
        {
          "name": "accX",
          "units": "text"
        }
      ],
      "valuesCount": 0,
      "totalLengthMs": 0,
      "added": "2024-12-21T14:30:09.041Z",
      "boundingBoxes": [
        {
          "label": "text",
          "x": 0,
          "y": 0,
          "width": 0,
          "height": 0
        }
      ],
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "thumbnailVideo": "text",
      "thumbnailVideoFull": "text",
      "isDisabled": false,
      "isProcessing": false,
      "processingJobId": 0,
      "processingError": false,
      "processingErrorString": "text",
      "isCropped": false,
      "projectId": 0,
      "projectOwnerName": "text",
      "projectName": "text",
      "projectLabelingMethod": "single_label",
      "sha256Hash": "text",
      "structuredLabels": [
        {
          "startIndex": 0,
          "endIndex": 0,
          "label": "text"
        }
      ],
      "structuredLabelsList": [
        "text"
      ],
      "createdBySyntheticDataJobId": 0,
      "imageDimensions": {
        "width": 0,
        "height": 0
      }
    }
  ],
  "totalCount": 0
}