Start sampling

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

deviceIdstringrequired

Device ID

Body

labelstringrequired

Label to be used during sampling.

lengthMsintegerrequired

Requested length of the sample (in ms).

intervalMsnumberrequired

Interval between samples (can be calculated like 1/hz * 1000)

sensorstring

The sensor to sample from.

categorystring · enumrequired

Which acquisition category to sample data into.

Options: training, testing, anomaly

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/start-sampling' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "label": "text",
    "lengthMs": 1,
    "intervalMs": 1,
    "sensor": "text",
    "category": "training"
  }'

200

200

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

OK