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

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

deviceIdstringrequired

Device ID

Body

resolutionstring · enumrequired

Options: high, low

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/debug-stream/snapshot/start' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "resolution": "high"
  }'

200

200

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

OK