Preview samples for AI Actions

Preview samples for AI Actions

post

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.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

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.

Possible values:

dataMetadataKeystringOptional

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

dataMetadataValuestringOptional

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

maxDataPreviewCountintegerRequired

Max. amount of data items to return.

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/{projectId}/ai-actions/{actionId}/preview-samples HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "saveConfig": true,
  "dataCategory": "allData",
  "dataMetadataKey": "text",
  "dataMetadataValue": "text",
  "maxDataPreviewCount": 1
}

200

OK

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