Evaluate

Evaluates every variant of the current impulse. Updates are streamed over the websocket API.

POST /api/{projectId}/jobs/evaluate

Evaluate

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/evaluate \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "id": 12873488112,
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Query Parameters

impulseId · integer

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

category · enum<string>

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

Available options: training, testing

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

id · integer · required

Job identifier. Status updates will include this identifier.

Example:

12873488112

error · string

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