Skip to main content
POST
/
api
/
{projectId}
/
device
/
{deviceId}
/
debug-stream
/
snapshot
/
start
Start snapshot debug stream
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId}/debug-stream/snapshot/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "resolution": "high"
}
'
{
  "success": true,
  "streamId": 123,
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

​
deviceId
string
required

Device ID

Body

application/json
​
resolution
enum<string>
required
Available options:
high,
low

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
streamId
integer
required
​
error
string

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