API and SDKs references

Deployment targets

List deployment targets for a project

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/targets

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

targets*array of all of

name*string

description*string

image*string

imageClasses*string

format*string

latencyDevicestring

hasEonCompiler*boolean

Preferably use supportedEngines / preferredEngine

hasTensorRT*boolean

Preferably use supportedEngines / preferredEngine

hasTensaiFlow*boolean

Preferably use supportedEngines / preferredEngine

hasDRPAI*boolean

Preferably use supportedEngines / preferredEngine

hasTIDL*boolean

Preferably use supportedEngines / preferredEngine

hasAkida*boolean

Preferably use supportedEngines / preferredEngine

hasMemryx*boolean

Preferably use supportedEngines / preferredEngine

hasStAton*boolean

Preferably use supportedEngines / preferredEngine

hideOptimizations*boolean

badgeobject

name*string

description*string

uiSection*enum

libraryfirmwaremobilehidden

customDeployIdinteger

integrateUrlstring

ownerOrganizationNamestring

supportedEngines*array of enum

itemsenum

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

preferredEngine*enum

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

urlstring

docsUrl*string

firmwareRepoUrlstring

recommendedForProject*boolean

Whether this deployment target is recommended for the project based on connected devices.

disabledForProject*boolean

Whether this deployment target is disabled for the project based on various attributes of the project.

reasonTargetDisabledstring

If the deployment target is disabled for the project, this gives the reason why.

Request

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

Response

{
  "success": false,
  "error": "text",
  "targets": [
    {
      "name": "text",
      "description": "text",
      "image": "text",
      "imageClasses": "text",
      "format": "text",
      "latencyDevice": "text",
      "hasEonCompiler": false,
      "hasTensorRT": false,
      "hasTensaiFlow": false,
      "hasDRPAI": false,
      "hasTIDL": false,
      "hasAkida": false,
      "hasMemryx": false,
      "hasStAton": false,
      "hideOptimizations": false,
      "badge": {
        "name": "text",
        "description": "text"
      },
      "uiSection": "library",
      "customDeployId": 0,
      "integrateUrl": "text",
      "ownerOrganizationName": "text",
      "supportedEngines": [
        "tflite"
      ],
      "preferredEngine": "tflite",
      "url": "text",
      "docsUrl": "text",
      "firmwareRepoUrl": "text",
      "recommendedForProject": false,
      "disabledForProject": false,
      "reasonTargetDisabled": "text"
    }
  ]
}

Check evaluate job result (cache)

Get evaluate job result, containing detailed performance statistics for every possible variant of the impulse. This only checks cache, and throws an error if there is no data in cache.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/evaluate/cache

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

result*array of object

modelType*enum

The type of model

int8float32akidarequiresRetrain

learnBlockId*integer

The learning block this model variant is from

learnBlockType*enum

The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.

anomalyanomaly-gmmkeraskeras-transfer-imagekeras-transfer-kwskeras-object-detectionkeras-regressionkeras-akidakeras-akida-transfer-imagekeras-akida-object-detectionkeras-visual-anomaly

confusionMatrix*object

A map from actual labels to predicted labels, where actual labels are listed in trainingLabels and possible predicted labels are listed in classificationLabels.

Other propertiesobject

rawnumber

The value based on the model alone

withAnomalynumber

The value including the result of anomaly detection

trainingLabels*array of string

The labels present in the model's training data. These are all present in the first dimension of the confusion matrix.

itemsstring

classificationLabels*array of string

The possible labels resulting from classification. These may be present in the second dimension of the confusion matrix.

itemsstring

totalWindowCountinteger

The total number of windows that were evaluated

totalCorrectWindowCountobject

The total number of windows that the model classified correctly

rawnumber

The value based on the model alone

withAnomalynumber

The value including the result of anomaly detection

accuracy*object

The model's accuracy as a percentage

rawnumber

The value based on the model alone

withAnomalynumber

The value including the result of anomaly detection

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/deployment/evaluate/cache', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "result": [
    {
      "modelType": "int8",
      "learnBlockId": 0,
      "learnBlockType": "anomaly",
      "trainingLabels": [
        "text"
      ],
      "classificationLabels": [
        "text"
      ],
      "totalWindowCount": 0,
      "totalCorrectWindowCount": {
        "raw": 0,
        "withAnomaly": 0
      },
      "accuracy": {
        "raw": 0,
        "withAnomaly": 0
      }
    }
  ]
}

Download

Download the build artefacts for a project

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/download

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

type*string

The name of the built target. You can find this by listing all deployment targets through listDeploymentTargetsForProject (via GET /v1/api/{projectId}/deployment/targets) and see the format type.

modelTypeenum

Optional model type of the build (if not, it uses the settings in the Keras block)

int8float32akidarequiresRetrain

engineenum

Optional engine for the build (if not, it uses the default engine for the deployment target)

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

ZIP or BIN file

Body

string (binary)

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/deployment/download?type=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

binary

Evaluate job result

Get evaluate job result, containing detailed performance statistics for every possible variant of the impulse.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/evaluate

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

result*array of object

modelType*enum

The type of model

int8float32akidarequiresRetrain

learnBlockId*integer

The learning block this model variant is from

learnBlockType*enum

The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.

anomalyanomaly-gmmkeraskeras-transfer-imagekeras-transfer-kwskeras-object-detectionkeras-regressionkeras-akidakeras-akida-transfer-imagekeras-akida-object-detectionkeras-visual-anomaly

confusionMatrix*object

A map from actual labels to predicted labels, where actual labels are listed in trainingLabels and possible predicted labels are listed in classificationLabels.

Other propertiesobject

rawnumber

The value based on the model alone

withAnomalynumber

The value including the result of anomaly detection

trainingLabels*array of string

The labels present in the model's training data. These are all present in the first dimension of the confusion matrix.

itemsstring

classificationLabels*array of string

The possible labels resulting from classification. These may be present in the second dimension of the confusion matrix.

itemsstring

totalWindowCountinteger

The total number of windows that were evaluated

totalCorrectWindowCountobject

The total number of windows that the model classified correctly

rawnumber

The value based on the model alone

withAnomalynumber

The value including the result of anomaly detection

accuracy*object

The model's accuracy as a percentage

rawnumber

The value based on the model alone

withAnomalynumber

The value including the result of anomaly detection

Request

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

Response

{
  "success": false,
  "error": "text",
  "result": [
    {
      "modelType": "int8",
      "learnBlockId": 0,
      "learnBlockType": "anomaly",
      "trainingLabels": [
        "text"
      ],
      "classificationLabels": [
        "text"
      ],
      "totalWindowCount": 0,
      "totalCorrectWindowCount": {
        "raw": 0,
        "withAnomaly": 0
      },
      "accuracy": {
        "raw": 0,
        "withAnomaly": 0
      }
    }
  ]
}

Get deployment info

Gives information on whether a deployment was already built for a type

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

type*string

modelTypeenum

Optional model type of the build (if not, it uses the settings in the Keras block)

int8float32akidarequiresRetrain

engineenum

Optional engine for the build (if not, it uses the default engine for the deployment target)

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasDeployment*boolean

versioninteger

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/deployment?type=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "hasDeployment": false,
  "version": 0
}

Deployment targets (data sources)

List deployment targets for a project from data sources page (it shows some things like all Linux deploys, and hides 'fake' deploy targets like mobile phone / computer)

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/targets/data-sources

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

targets*array of object

name*string

description*string

image*string

imageClasses*string

format*string

latencyDevicestring

hasEonCompiler*boolean

Preferably use supportedEngines / preferredEngine

hasTensorRT*boolean

Preferably use supportedEngines / preferredEngine

hasTensaiFlow*boolean

Preferably use supportedEngines / preferredEngine

hasDRPAI*boolean

Preferably use supportedEngines / preferredEngine

hasTIDL*boolean

Preferably use supportedEngines / preferredEngine

hasAkida*boolean

Preferably use supportedEngines / preferredEngine

hasMemryx*boolean

Preferably use supportedEngines / preferredEngine

hasStAton*boolean

Preferably use supportedEngines / preferredEngine

hideOptimizations*boolean

badgeobject

name*string

description*string

uiSection*enum

libraryfirmwaremobilehidden

customDeployIdinteger

integrateUrlstring

ownerOrganizationNamestring

supportedEngines*array of enum

itemsenum

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

preferredEngine*enum

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

urlstring

docsUrl*string

firmwareRepoUrlstring

Request

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

Response

{
  "success": false,
  "error": "text",
  "targets": [
    {
      "name": "text",
      "description": "text",
      "image": "text",
      "imageClasses": "text",
      "format": "text",
      "latencyDevice": "text",
      "hasEonCompiler": false,
      "hasTensorRT": false,
      "hasTensaiFlow": false,
      "hasDRPAI": false,
      "hasTIDL": false,
      "hasAkida": false,
      "hasMemryx": false,
      "hasStAton": false,
      "hideOptimizations": false,
      "badge": {
        "name": "text",
        "description": "text"
      },
      "uiSection": "library",
      "customDeployId": 0,
      "integrateUrl": "text",
      "ownerOrganizationName": "text",
      "supportedEngines": [
        "tflite"
      ],
      "preferredEngine": "tflite",
      "url": "text",
      "docsUrl": "text",
      "firmwareRepoUrl": "text"
    }
  ]
}

Get Syntiant posterior parameters

Get the current posterior parameters for the Syntiant deployment target

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/syntiant/posterior

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasPosteriorParameters*boolean

parametersobject

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/deployment/syntiant/posterior', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "hasPosteriorParameters": false
}

Set Syntiant posterior parameters

Set the current posterior parameters for the Syntiant deployment target

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/syntiant/posterior

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Body

parameters*object

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/deployment/syntiant/posterior', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}

Get information on the last deployment build

Get information on the result of the last successful deployment job, including info on the build e.g. whether it is still valid.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/deployment/last

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

hasBuild*boolean

Does the deployment build still exist? (Builds are deleted if they are no longer valid for the project)

lastBuildobject

version*integer

The build version, incremented after each deployment build

deploymentType*string

Deployment type of the build

engine*enum

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

modelTypeenum

int8float32akidarequiresRetrain

created*string (date-time)

The time this build was created

lastDeploymentTargetall of

name*string

description*string

image*string

imageClasses*string

format*string

latencyDevicestring

hasEonCompiler*boolean

Preferably use supportedEngines / preferredEngine

hasTensorRT*boolean

Preferably use supportedEngines / preferredEngine

hasTensaiFlow*boolean

Preferably use supportedEngines / preferredEngine

hasDRPAI*boolean

Preferably use supportedEngines / preferredEngine

hasTIDL*boolean

Preferably use supportedEngines / preferredEngine

hasAkida*boolean

Preferably use supportedEngines / preferredEngine

hasMemryx*boolean

Preferably use supportedEngines / preferredEngine

hasStAton*boolean

Preferably use supportedEngines / preferredEngine

hideOptimizations*boolean

badgeobject

name*string

description*string

uiSection*enum

libraryfirmwaremobilehidden

customDeployIdinteger

integrateUrlstring

ownerOrganizationNamestring

supportedEngines*array of enum

itemsenum

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

preferredEngine*enum

tflitetflite-eontflite-eon-ram-optimizedtensorrttensaiflowdrp-aitidlakidasyntiantmemryxneoxethos-linuxst-aton

urlstring

docsUrl*string

firmwareRepoUrlstring

recommendedForProject*boolean

Whether this deployment target is recommended for the project based on connected devices.

disabledForProject*boolean

Whether this deployment target is disabled for the project based on various attributes of the project.

reasonTargetDisabledstring

If the deployment target is disabled for the project, this gives the reason why.

Request

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

Response

{
  "success": false,
  "error": "text",
  "hasBuild": false,
  "lastBuild": {
    "version": 0,
    "deploymentType": "text",
    "engine": "tflite",
    "modelType": "int8",
    "created": "2025-02-04T02:49:16.983Z"
  },
  "lastDeploymentTarget": {
    "name": "text",
    "description": "text",
    "image": "text",
    "imageClasses": "text",
    "format": "text",
    "latencyDevice": "text",
    "hasEonCompiler": false,
    "hasTensorRT": false,
    "hasTensaiFlow": false,
    "hasDRPAI": false,
    "hasTIDL": false,
    "hasAkida": false,
    "hasMemryx": false,
    "hasStAton": false,
    "hideOptimizations": false,
    "badge": {
      "name": "text",
      "description": "text"
    },
    "uiSection": "library",
    "customDeployId": 0,
    "integrateUrl": "text",
    "ownerOrganizationName": "text",
    "supportedEngines": [
      "tflite"
    ],
    "preferredEngine": "tflite",
    "url": "text",
    "docsUrl": "text",
    "firmwareRepoUrl": "text",
    "recommendedForProject": false,
    "disabledForProject": false,
    "reasonTargetDisabled": "text"
  }
}

Find Syntiant posterior parameters

Automatically find the current posterior parameters for the Syntiant deployment target

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/find-syntiant-posterior

Authorization

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Body

targetWords*array of string

itemsstring

referenceSet*enum

600_secondsfullcustomno_calibration

wavFilestring (binary)

metaCsvFilestring (binary)

deploymentTargetenum

syntiant-ndp101syntiant-ndp101-libsyntiant-ndp120-libsyntiant-ndp120-lib-tdk-v14syntiant-nicla-ndp120syntiant-avnet-rasynsyntiant-ndp120-lib-ndp-v1-15-0

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/find-syntiant-posterior', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "targetWords": [
        "text"
      ],
      "referenceSet": "600_seconds"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "id": 12873488112
}