Performance Calibration

Performance Calibration

post

Simulates real world usage and returns performance metrics.

Authorizations
Path parameters
projectIdintegerRequired

Project ID

Query parameters
impulseIdintegerOptional

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

Body
backgroundNoiseLabelstringRequired

The label used to signify background noise in the impulse

otherNoiseLabelsstring[]Optional

Any other labels that should be considered equivalent to background noise

uploadKeystringOptional

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

sampleLengthMinutesnumberOptional

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

Responses
200
OK
application/json
Responseall of
post
POST /v1/api/{projectId}/jobs/performance-calibration HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "backgroundNoiseLabel": "text",
  "otherNoiseLabels": [
    "text"
  ],
  "uploadKey": "text",
  "sampleLengthMinutes": 1
}
200

OK

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

Last updated

Was this helpful?