Classify

Classify an image

Test out a trained impulse (using a posted image).

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

projectIdinteger required

Project ID

impulseIdinteger

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

imagestring binary required

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.

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