Start sampling
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"lengthMs": 123,
"intervalMs": 123,
"sensor": "<string>",
"labelColor": "<string>",
"collectedSampleCount": 123,
"targetSampleCount": 123
}
'import requests
url = "https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling"
payload = {
"label": "<string>",
"lengthMs": 123,
"intervalMs": 123,
"sensor": "<string>",
"labelColor": "<string>",
"collectedSampleCount": 123,
"targetSampleCount": 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({
label: '<string>',
lengthMs: 123,
intervalMs: 123,
sensor: '<string>',
labelColor: '<string>',
collectedSampleCount: 123,
targetSampleCount: 123
})
};
fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling', 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}/device/{deviceId}/start-sampling",
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([
'label' => '<string>',
'lengthMs' => 123,
'intervalMs' => 123,
'sensor' => '<string>',
'labelColor' => '<string>',
'collectedSampleCount' => 123,
'targetSampleCount' => 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}/device/{deviceId}/start-sampling"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"lengthMs\": 123,\n \"intervalMs\": 123,\n \"sensor\": \"<string>\",\n \"labelColor\": \"<string>\",\n \"collectedSampleCount\": 123,\n \"targetSampleCount\": 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}/device/{deviceId}/start-sampling")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"lengthMs\": 123,\n \"intervalMs\": 123,\n \"sensor\": \"<string>\",\n \"labelColor\": \"<string>\",\n \"collectedSampleCount\": 123,\n \"targetSampleCount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling")
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 \"label\": \"<string>\",\n \"lengthMs\": 123,\n \"intervalMs\": 123,\n \"sensor\": \"<string>\",\n \"labelColor\": \"<string>\",\n \"collectedSampleCount\": 123,\n \"targetSampleCount\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": "<string>",
"id": 123
}Start sampling
Start sampling on a device. This function returns immediately. Updates are streamed through the websocket API.
POST
/
api
/
{projectId}
/
device
/
{deviceId}
/
start-sampling
Start sampling
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"lengthMs": 123,
"intervalMs": 123,
"sensor": "<string>",
"labelColor": "<string>",
"collectedSampleCount": 123,
"targetSampleCount": 123
}
'import requests
url = "https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling"
payload = {
"label": "<string>",
"lengthMs": 123,
"intervalMs": 123,
"sensor": "<string>",
"labelColor": "<string>",
"collectedSampleCount": 123,
"targetSampleCount": 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({
label: '<string>',
lengthMs: 123,
intervalMs: 123,
sensor: '<string>',
labelColor: '<string>',
collectedSampleCount: 123,
targetSampleCount: 123
})
};
fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling', 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}/device/{deviceId}/start-sampling",
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([
'label' => '<string>',
'lengthMs' => 123,
'intervalMs' => 123,
'sensor' => '<string>',
'labelColor' => '<string>',
'collectedSampleCount' => 123,
'targetSampleCount' => 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}/device/{deviceId}/start-sampling"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"lengthMs\": 123,\n \"intervalMs\": 123,\n \"sensor\": \"<string>\",\n \"labelColor\": \"<string>\",\n \"collectedSampleCount\": 123,\n \"targetSampleCount\": 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}/device/{deviceId}/start-sampling")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"lengthMs\": 123,\n \"intervalMs\": 123,\n \"sensor\": \"<string>\",\n \"labelColor\": \"<string>\",\n \"collectedSampleCount\": 123,\n \"targetSampleCount\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling")
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 \"label\": \"<string>\",\n \"lengthMs\": 123,\n \"intervalMs\": 123,\n \"sensor\": \"<string>\",\n \"labelColor\": \"<string>\",\n \"collectedSampleCount\": 123,\n \"targetSampleCount\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"error": "<string>",
"id": 123
}Authorizations
ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2
Body
application/json
Label to be used during sampling.
Requested length of the sample (in ms).
Which acquisition category to sample data into.
Available options:
training, testing, validation, post-processing Interval between samples (can be calculated like 1/hz * 1000)
The sensor to sample from.
Text color of label displayed on supported clients. Value can be any supported CSS color value
A hint to supported clients to show the number of samples currently collected
A hint to supported clients to show the desired number of samples to be collected
Was this page helpful?
⌘I