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.

post

/api/{projectId}/ai-actions/{actionId}/preview-samples

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

actionIdintegerrequired

AI Action ID

Body

saveConfigbooleanrequired

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

dataCategorystring · enumrequired

Type of data to preview. A random subset of this data will be returned.

Options: allData, unlabeledData, dataWithoutMetadataKey, dataWithMetadata

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

maxDataPreviewCountintegerrequired

Max. amount of data items to return.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/ai-actions/{actionId}/preview-samples' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"saveConfig":true,"dataCategory":"allData","maxDataPreviewCount":1}'

200

200

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

OK