POST
/
api
/
{projectId}
/
ai-actions
/
{actionId}
/
preview-samples
Preview samples for AI Actions
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/ai-actions/{actionId}/preview-samples \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "saveConfig": true,
  "dataCategory": "allData",
  "dataMetadataKey": "<string>",
  "dataMetadataValue": "<string>",
  "maxDataPreviewCount": 123
}'
{
  "success": true,
  "error": "<string>",
  "samples": [
    {
      "id": 2,
      "filename": "idle01.d8Ae",
      "signatureValidate": true,
      "signatureMethod": "HS256",
      "signatureKey": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "lastModified": "2023-11-07T05:31:56Z",
      "category": "training",
      "coldstorageFilename": "<string>",
      "label": "healthy-machine",
      "intervalMs": 16,
      "frequency": 62.5,
      "originalIntervalMs": 16,
      "originalFrequency": 62.5,
      "deviceName": "<string>",
      "deviceType": "<string>",
      "sensors": [
        {
          "name": "accX",
          "units": "<string>"
        }
      ],
      "valuesCount": 123,
      "totalLengthMs": 123,
      "added": "2023-11-07T05:31:56Z",
      "boundingBoxes": [
        {
          "label": "<string>",
          "x": 123,
          "y": 123,
          "width": 123,
          "height": 123
        }
      ],
      "boundingBoxesType": "object_detection",
      "chartType": "chart",
      "thumbnailVideo": "<string>",
      "thumbnailVideoFull": "<string>",
      "isDisabled": true,
      "isProcessing": true,
      "processingJobId": 123,
      "processingError": true,
      "processingErrorString": "<string>",
      "isCropped": true,
      "metadata": {},
      "projectId": 123,
      "projectOwnerName": "<string>",
      "projectName": "<string>",
      "projectLabelingMethod": "single_label",
      "sha256Hash": "<string>",
      "structuredLabels": [
        {
          "startIndex": 123,
          "endIndex": 123,
          "label": "<string>"
        }
      ],
      "structuredLabelsList": [
        "<string>"
      ],
      "createdBySyntheticDataJobId": 123,
      "imageDimensions": {
        "width": 123,
        "height": 123
      },
      "videoUrl": "<string>",
      "videoUrlFull": "<string>"
    }
  ],
  "totalCount": 123
}

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

actionId
integer
required

AI Action ID

Body

application/json
saveConfig
boolean
required

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

dataCategory
enum<string>
required

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

Available options:
allData,
unlabeledData,
enabledData,
dataWithoutMetadataKey,
dataWithMetadata
maxDataPreviewCount
integer
required

Max. amount of data items to return.

dataMetadataKey
string

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

dataMetadataValue
string

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

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

samples
object[]
required
totalCount
integer
required
error
string

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