Get status

Get performance calibration status

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/status

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

available*boolean

unsupportedProjectErrorstring

If the current project is unsupported by performance calibration, this field explains the reason why. Otherwise, it is undefined.

optionsStartPerformanceCalibrationRequest (object)

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

itemsstring

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)

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "available": false,
  "unsupportedProjectError": "text",
  "options": {
    "backgroundNoiseLabel": "text",
    "otherNoiseLabels": [
      "text"
    ],
    "uploadKey": "text",
    "sampleLengthMinutes": 0
  }
}

Get status

Get performance calibration status

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/status

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

available*boolean

unsupportedProjectErrorstring

If the current project is unsupported by performance calibration, this field explains the reason why. Otherwise, it is undefined.

optionsStartPerformanceCalibrationRequest (object)

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

itemsstring

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)

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/performance-calibration/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "available": false,
  "unsupportedProjectError": "text",
  "options": {
    "backgroundNoiseLabel": "text",
    "otherNoiseLabels": [
      "text"
    ],
    "uploadKey": "text",
    "sampleLengthMinutes": 0
  }
}