API and SDKs references

Build on-device model

Generate code to run the impulse on an embedded device. When this step is complete use downloadBuild to download the artefacts. Updates are streamed over the websocket API.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/build-ondevice-model

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.

impulseIdinteger

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

Body

engine*enum

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

modelTypeenum

int8float32akidarequiresRetrain

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

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/build-ondevice-model?type=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "engine": "tflite"
    }),
});
const data = await response.json();