Devices

Start snapshot debug stream

Start a snapshot debug stream for this device with a current camera view. Updates are streamed through the websocket API. A keep-alive token is returned, you'll need to ping the API (with keepDeviceDebugStreamAlive) every 10 seconds (so we know when the client is disconnected).

post/api/{projectId}/device/{deviceId}/debug-stream/snapshot/start

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/debug-stream/snapshot/start/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

deviceIdstring required

Device ID

Request body

resolution'high' | 'low' required

Response

successboolean required

Whether the operation succeeded

errorstring

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

streamIdinteger required

Changes

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