Classify

Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/classify

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

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

Body

modelVariantsarray of KerasModelVariantEnum (enum)

Set of model variants to run the classify job against.

itemsKerasModelVariantEnum (enum)

int8float32akida

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

Classify

Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/classify

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

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

Body

modelVariantsarray of KerasModelVariantEnum (enum)

Set of model variants to run the classify job against.

itemsKerasModelVariantEnum (enum)

int8float32akida

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/classify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "id": 12873488112
}