Jobs

Build on-device model

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

post/api/{projectId}/jobs/build-ondevice-model

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/jobs/build-ondevice-model/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

typestring required

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.

Request body

modelType'int8' | 'float32' | 'akida'

parametersobject

List of custom parameters for this deployment job (see the list of parameters that the block exposes in DeploymentTarget#parameters).

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Job identifier. Status updates will include this identifier.

deploymentVersioninteger required

Deployment version, use downloadHistoricDeployment to later download the deployment using this identifier.

Example response

{
  "id": 12873488112
}

Changes

No recorded changes to this operation across all 1 revision of this API.