Jobs

Classify

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

post/api/{projectId}/jobs/classify

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/jobs/classify/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.

category'training' | 'testing'

Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.

modelVariantsKerasModelVariantEnum[]

Set of model variants to run the classify job against.

skipFeatureGenerationboolean

If enabled, skips feature generation altogether. Used e.g. if you update thresholds.

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Job identifier. Status updates will include this identifier.

{
  "id": 12873488112
}

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