Jobs

Performance Calibration

Simulates real world usage and returns performance metrics.

post/api/{projectId}/jobs/performance-calibration

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/performance-calibration/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.

backgroundNoiseLabelstring required

The label used to signify background noise in the impulse

otherNoiseLabelsstring[]

Any other labels that should be considered equivalent to background noise

uploadKeystring

The key of an uploaded sample. If not present, a synthetic sample will be created.

sampleLengthMinutesnumber

The length of sample to create (required for synthetic samples)

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.