Start snapshot debug stream

Start snapshot debug stream

post

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

projectIdintegerRequired

Project ID

deviceIdstringRequired

Device ID

Body

resolutionstring · enumRequiredPossible values:

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/{projectId}/device/{deviceId}/debug-stream/snapshot/start HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "resolution": "high"
}

200

OK

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