Performance Calibration

Performance Calibration

Simulates real world usage and returns performance metrics.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration

Path parameters

projectId*integer

Project ID

Body

application/json

backgroundNoiseLabel*string

The label used to signify background noise in the impulse

otherNoiseLabelsarray of string

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)

Response

200

OK

Body

application/json

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

JavaScriptCurl

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

Response

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