Learn

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

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/pretrained-model/test-image/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

imageFileBase64string required

A base64 encoded input image file

Example request

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

Response

successboolean required

Whether the operation succeeded

errorstring

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

resultobject

Classification value per label. For a neural network this will be the confidence, for anomalies the anomaly score.

Changes

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