Start snapshot debug stream

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).

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/debug-stream/snapshot/start

Path parameters

projectId*integer

Project ID

deviceId*string

Device ID

Body

application/json

resolution*enum

highlow

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

streamId*integer

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/debug-stream/snapshot/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "resolution": "high"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}