Performance Calibration
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"backgroundNoiseLabel": "<string>",
"otherNoiseLabels": [
"<string>"
],
"uploadKey": "<string>",
"sampleLengthMinutes": 123
}
'import requests
url = "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration"
payload = {
"backgroundNoiseLabel": "<string>",
"otherNoiseLabels": ["<string>"],
"uploadKey": "<string>",
"sampleLengthMinutes": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
backgroundNoiseLabel: '<string>',
otherNoiseLabels: ['<string>'],
uploadKey: '<string>',
sampleLengthMinutes: 123
})
};
fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'backgroundNoiseLabel' => '<string>',
'otherNoiseLabels' => [
'<string>'
],
'uploadKey' => '<string>',
'sampleLengthMinutes' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration"
payload := strings.NewReader("{\n \"backgroundNoiseLabel\": \"<string>\",\n \"otherNoiseLabels\": [\n \"<string>\"\n ],\n \"uploadKey\": \"<string>\",\n \"sampleLengthMinutes\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"backgroundNoiseLabel\": \"<string>\",\n \"otherNoiseLabels\": [\n \"<string>\"\n ],\n \"uploadKey\": \"<string>\",\n \"sampleLengthMinutes\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"backgroundNoiseLabel\": \"<string>\",\n \"otherNoiseLabels\": [\n \"<string>\"\n ],\n \"uploadKey\": \"<string>\",\n \"sampleLengthMinutes\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"id": 12873488112,
"error": "<string>"
}Performance Calibration
Simulates real world usage and returns performance metrics.
POST
/
api
/
{projectId}
/
jobs
/
performance-calibration
Performance Calibration
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"backgroundNoiseLabel": "<string>",
"otherNoiseLabels": [
"<string>"
],
"uploadKey": "<string>",
"sampleLengthMinutes": 123
}
'import requests
url = "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration"
payload = {
"backgroundNoiseLabel": "<string>",
"otherNoiseLabels": ["<string>"],
"uploadKey": "<string>",
"sampleLengthMinutes": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
backgroundNoiseLabel: '<string>',
otherNoiseLabels: ['<string>'],
uploadKey: '<string>',
sampleLengthMinutes: 123
})
};
fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'backgroundNoiseLabel' => '<string>',
'otherNoiseLabels' => [
'<string>'
],
'uploadKey' => '<string>',
'sampleLengthMinutes' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration"
payload := strings.NewReader("{\n \"backgroundNoiseLabel\": \"<string>\",\n \"otherNoiseLabels\": [\n \"<string>\"\n ],\n \"uploadKey\": \"<string>\",\n \"sampleLengthMinutes\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"backgroundNoiseLabel\": \"<string>\",\n \"otherNoiseLabels\": [\n \"<string>\"\n ],\n \"uploadKey\": \"<string>\",\n \"sampleLengthMinutes\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/performance-calibration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"backgroundNoiseLabel\": \"<string>\",\n \"otherNoiseLabels\": [\n \"<string>\"\n ],\n \"uploadKey\": \"<string>\",\n \"sampleLengthMinutes\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"id": 12873488112,
"error": "<string>"
}Authorizations
ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2
Path Parameters
Project ID
Query Parameters
Impulse ID. If this is unset then the default impulse is used.
Body
application/json
The label used to signify background noise in the impulse
Any other labels that should be considered equivalent to background noise
The key of an uploaded sample. If not present, a synthetic sample will be created.
The length of sample to create (required for synthetic samples)
Was this page helpful?
⌘I