Devices

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/device/:deviceId/start-sampling/post.ts
A function with typed inputs. Its response is checked against the schema.

projectIdinteger required

Project ID

deviceIdstring required

Device ID

labelstring required

Label to be used during sampling.

lengthMsinteger required

Requested length of the sample (in ms).

category'training' | 'testing' | 'validation' | 'post-processing' required

intervalMsnumber required

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

sensorstring

The sensor to sample from.

labelColorstring

Text color of label displayed on supported clients. Value can be any supported CSS color value

collectedSampleCountnumber

A hint to supported clients to show the number of samples currently collected

targetSampleCountnumber

A hint to supported clients to show the desired number of samples to be collected

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

No recorded changes to this operation across all 1 revision of this API.