Classify an image

Classify an image

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

post

/api/{projectId}/classify/image

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Query parameters

impulseIdinteger

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

Body

imagestring · binaryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/classify/image' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"image":"text"}'

200

200

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

OK