Skip to main content
POST
Performance Calibration

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

Query Parameters

impulseId
integer

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

Body

application/json
backgroundNoiseLabel
string
required

The label used to signify background noise in the impulse

otherNoiseLabels
string[]

Any other labels that should be considered equivalent to background noise

uploadKey
string

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

sampleLengthMinutes
number

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

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

id
integer
required

Job identifier. Status updates will include this identifier.

Example:

12873488112

error
string

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