Performance Calibration

Performance Calibration

post

Simulates real world usage and returns performance metrics.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "backgroundNoiseLabel": "text",
    "otherNoiseLabels": [
      "text"
    ],
    "uploadKey": "text",
    "sampleLengthMinutes": 1
  }'

200

200

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

OK