A single duplex WebSocket session between one device (or the serial daemon acting as its proxy) and the Edge Impulse remote management service. Devices authenticate by sending their project apiKey inside the Hello message.
Server starts or stops snapshot streaming (protocol v3+).
send
sendSnapshotFrame
Device streams a snapshot frame.
Messages
Hello
First message of the session. Only a device sends it; the encoding of this message (JSON or CBOR) fixes the encoding for the rest of the session.
Content-Type: application/json
HelloResponse
Server acknowledgement of the device handshake.
Content-Type: application/json
Sample
Server instructs the device to acquire a new sample.
Content-Type: application/json
SampleResponse
Device acknowledges (or rejects) the sampling request.
Content-Type: application/json
SampleStarted
Sampling has begun on the device.
Content-Type: application/json
SampleProcessing
The device is processing the acquired sample.
Content-Type: application/json
SampleReading
The daemon is pulling data off the device over serial; carries a progress percentage. May be sent repeatedly.
Content-Type: application/json
SampleUploading
The device is uploading the sample to the Ingestion API.
Content-Type: application/json
SampleFinished
The sampling cycle is complete.
Content-Type: application/json
StartSnapshot
Server asks the device to begin streaming snapshot frames. Protocol v3 and above.
Content-Type: application/json
StopSnapshot
Server asks the device to stop streaming snapshot frames. Protocol v3 and above.
Content-Type: application/json
SnapshotFrame
A single snapshot frame from the device.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.