Jobs

Deploy pretrained model

Takes in a TFLite file and builds the model and SDK. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.

post/api/{projectId}/jobs/deploy-pretrained-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/deploy-pretrained-model/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

impulseIdinteger

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

Request body

modelFileBase64string required

A base64 encoded pretrained model

deploymentTypestring 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.

representativeFeaturesBase64string

A base64 encoded .npy file containing the features from your validation set (optional for onnx and saved_model) - used to quantize your model.

deployModelType'int8' | 'float32'

useConverter'onnx-tf' | 'onnx2tf'

Optional, use a specific converter (only for ONNX models).

overrideInputShapeinteger[]

Optional for ONNX files: overrides the input shape of the model. This is highly suggested if the model has dynamic dimensions. If this field is not set, then all dynamic dimensions will be set to '1'.

Example request

{
  "modelInfo": {
    "input": {
      "resizeMode": "squash"
    }
  }
}

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.

Example response

{
  "id": 12873488112
}

Changes

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