Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Impulse Devices API

The Devices API from Edge Impulse — 11 operation(s) for devices.

Edge Impulse Devices API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 11 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

12 operations 11 paths 13 schemas 1 DELETE2 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse Devices API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuthentication). An API key is passed in the cookie as jwt (JWTAuthentication). An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication). By default, every request must be authenticated.

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Devices 12
GET
/api/{projectId}/devices
Lists devices
listDevices 1 param → 200
GET
/api/{projectId}/device/{deviceId}
Get device
getDevice 2 params → 200
DELETE
/api/{projectId}/device/{deviceId}
Delete device
deleteDevice 2 params → 200
POST
/api/{projectId}/device/{deviceId}/start-sampling
Start sampling
startSampling 2 params body → 200
POST
/api/{projectId}/device/{deviceId}/debug-stream/inference/start
Start inference debug stream
startDeviceInferenceDebugStream 2 params → 200
POST
/api/{projectId}/device/{deviceId}/debug-stream/snapshot/start
Start snapshot debug stream
startDeviceSnapshotDebugStream 2 params body → 200
POST
/api/{projectId}/device/{deviceId}/debug-stream/keep-alive
Keep debug stream alive
keepDeviceDebugStreamAlive 2 params body → 200
POST
/api/{projectId}/device/{deviceId}/debug-stream/stop
Stop debug stream
stopDeviceDebugStream 2 params body → 200
POST
/api/{projectId}/device/{deviceId}/get-impulse-records
Get impulse records
getImpulseRecords 2 params body → 200
POST
/api/{projectId}/devices/create
Create device
createDevice 1 param body → 200
POST
/api/{projectId}/devices/{deviceId}/rename
Rename device
renameDevice 2 params body → 200
POST
/api/{projectId}/devices/{deviceId}/request-model-update
Trigger model update request
requestDeviceModelUpdate 2 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Device (12 properties), StartSamplingRequest (5 properties), GetImpulseRecordsRequest (3 properties), CreateDeviceRequest (3 properties). Each schema is shown below with its type and property counts.

StartDeviceSnapshotDebugStreamRequest
object
1 property 1 required
KeepDeviceDebugStreamAliveRequest
object
1 property 1 required
RenameDeviceRequest
object
1 property 1 required
StartDeviceDebugStreamResponse
StartSamplingResponse
StartSamplingRequest
object
5 properties 4 required
StopDeviceDebugStreamRequest
object
1 property 1 required
GetDeviceResponse
ListDevicesResponse
CreateDeviceRequest
object
3 properties 3 required
GetImpulseRecordsRequest
object
3 properties
GenericApiResponse
object
2 properties 1 required
Device
object
12 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-devices-api-openapi.yml Raw ↑

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API
Edge Impulse Impulse API