Devices

Create device

Create a new device. If you set ifNotExists to false and the device already exists, the deviceType will be overwritten.

post/api/{projectId}/devices/create

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/devices/create/post.ts
A function with typed inputs. Its response is checked against the schema.

projectIdinteger required

Project ID

deviceIdstring required

Globally unique device identifier (e.g. MAC address)

deviceTypestring required

Device type, for example the exact model of the device. Should be the same for all similar devices

ifNotExistsboolean required

Whether to throw an error when this device already exists.

{
  "deviceId": "ac:87:a3:0a:2d:1b",
  "deviceType": "DISCO_L475VG_IOT01A"
}

successboolean required

Whether the operation succeeded

errorstring

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

No recorded changes to this operation across all 1 revision of this API.