Get AI Actions config

Get AI Actions config

Get an AI Actions config

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/ai-actions/{actionId}

Path parameters

projectId*integer

Project ID

actionId*integer

AI Action ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

action*AIAction (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "error": "text",
  "action": {
    "id": 0,
    "name": "text",
    "displayName": "text",
    "config": {
      "dataCategory": "allData",
      "dataMetadataKey": "text",
      "dataMetadataValue": "text",
      "steps": [
        {
          "transformationBlockId": 0
        }
      ]
    },
    "previewConfig": {
      "dataCategory": "allData",
      "dataMetadataKey": "text",
      "dataMetadataValue": "text",
      "steps": [
        {
          "transformationBlockId": 0
        }
      ]
    },
    "maxDataPreviewCount": 0,
    "gridColumnCount": 0,
    "lastPreviewState": {
      "samples": [
        {
          "id": 2,
          "filename": "idle01.d8Ae",
          "signatureValidate": true,
          "signatureMethod": "HS256",
          "signatureKey": "text",
          "created": "2024-12-21T14:12:34.628Z",
          "lastModified": "2024-12-21T14:12:34.628Z",
          "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:12:34.628Z",
          "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
          }
        }
      ],
      "proposedChanges": [
        {
          "sampleId": 0,
          "step": 0,
          "proposedChanges": {
            "label": "text",
            "isDisabled": false,
            "boundingBoxes": [
              {
                "label": "text",
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
              }
            ],
            "structuredLabels": [
              {
                "startIndex": 0,
                "endIndex": 0,
                "label": "text"
              }
            ]
          }
        }
      ]
    },
    "setMetadataAfterRunning": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "cacheUnchangedSteps": false
  }
}