Edge Impulse API and SDKs Documentation

Test pretrained model using image data

Test out a pretrained model (using image data) - upload first via uploadPretrainedModel. If you want to deploy a pretrained model from the API, see startDeployPretrainedModelJob. This will transform raw image data (e.g. RGB to grayscale, resize) before classifying. To classify raw features, see testPretrainedModel.

post

/api/{projectId}/pretrained-model/test-image

Authorizations

Path parameters

projectIdintegerrequired

Project ID

Query parameters

impulseIdinteger

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

Body

imageFileBase64stringrequired

A base64 encoded input image file

inputobjectrequired

modelone ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/pretrained-model/test-image' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "imageFileBase64": "text",
    "input": {
      "resizeMode": "squash",
      "inputScaling": "0..1"
    },
    "model": {
      "modelType": "classification",
      "labels": [
        "text"
      ]
    }
  }'

200

{
  "success": true,
  "error": "text",
  "result": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "boundingBoxes": [
    {
      "label": "text",
      "x": 1,
      "y": 1,
      "width": 1,
      "height": 1,
      "score": 1
    }
  ]
}