Start inference debug stream

Start inference debug stream

Start an inference debug stream for this device with inference results (and images if a camera is attached). 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/inference/start

Path parameters

projectId*integer

Project ID

deviceId*string

Device ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

streamId*integer

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/debug-stream/inference/start', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

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