Edge Impulse

Edge Impulse Devices API

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

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/{projectId}/devices List a project's devices · Lists devices #
Ask an LLM
“Which devices are connected to my Edge Impulse project?”
“Why does a device appear in the list even though it only sent data to ingestion?”
Tell an agent
List all devices in project {project}.
Show every device that has connected to or sent data into project {project}.
GET /api/{projectId}/device/{deviceId} Get one device's details · Get device #
Ask an LLM
“Can I look up a single device and see its sensors and status?”
“Is a particular device currently connected to remote management?”
Tell an agent
Get device {device} in project {project}.
Show details of device {device} for project {project}.
DELETE /api/{projectId}/device/{deviceId} Delete a device · Delete device #
Ask an LLM
“Can I remove a device from my project?”
“Will a deleted device come back if it sends data again?”
Tell an agent destructive · confirm first
Delete device {device} from project {project}.
Remove device {device} out of project {project}.
POST /api/{projectId}/device/{deviceId}/start-sampling Start sampling data on a device · Start sampling #
Ask an LLM
“How do I trigger a device to record a labeled sample remotely?”
“Can I choose which sensor and sampling interval a device records with?”
Tell an agent
Start sampling {length} ms of {label} data on device {device} in project {project} into {category} at interval {interval} ms.
Record a {label} sample from sensor {sensor} on device {device} in project {project}, {length} ms long, interval {interval} ms, into {category}.
POST /api/{projectId}/device/{deviceId}/debug-stream/inference/start Start an inference debug stream · Start inference debug stream #
Ask an LLM
“Can I watch live inference results from a device as they happen?”
“How often must I ping to keep an inference debug stream open?”
Tell an agent
Start an inference debug stream on device {device} in project {project}.
Stream live classification results from device {device} of project {project}.
POST /api/{projectId}/device/{deviceId}/debug-stream/snapshot/start Start a camera snapshot debug stream · Start snapshot debug stream #
Ask an LLM
“Can I see a live camera view from a device?”
“What resolution options apply to a device's snapshot stream?”
Tell an agent
Start a snapshot debug stream at {resolution} resolution on device {device} in project {project}.
Show the live camera feed of device {device} in project {project} at {resolution}.
POST /api/{projectId}/device/{deviceId}/debug-stream/keep-alive Keep a device debug stream alive · Keep debug stream alive #
Ask an LLM
“What happens if I stop pinging an open device debug stream?”
“Which ID do I send to keep a debug stream from timing out?”
Tell an agent
Keep debug stream {stream} alive on device {device} in project {project}.
Send a keep-alive ping for stream {stream} on device {device} of project {project}.
POST /api/{projectId}/device/{deviceId}/debug-stream/stop Stop a device debug stream · Stop debug stream #
Ask an LLM
“Can I close a debug stream I opened on a device?”
“Is there a way to end a device's live debug view on demand?”
Tell an agent destructive · confirm first
Stop debug stream {stream} on device {device} in project {project}.
Close the open debug stream {stream} for device {device} of project {project}.
POST /api/{projectId}/device/{deviceId}/get-impulse-records Retrieve impulse records from a device · Get impulse records #
Ask an LLM
“Can I pull the stored impulse records off a deployed device?”
“Is it possible to fetch just a range of records from a device?”
Tell an agent
Get impulse records from device {device} in project {project}.
Retrieve impulse records in range {range} from device {device} of project {project}.
POST /api/{projectId}/devices/create Register a new device · Create device #
Ask an LLM
“How do I register a device in a project before it sends data?”
“What happens to the device type if I create a device that already exists?”
Tell an agent
Create device {device} of type {type} in project {project}, failing if it exists: {strict}.
Register device with MAC {device} as a {type} in project {project}.
POST /api/{projectId}/devices/{deviceId}/rename Rename a device · Rename device #
Ask an LLM
“Can I give a device a friendlier name?”
“Where do I set the display name of a device?”
Tell an agent
Rename device {device} in project {project} to {name}.
Call device {device} of project {project} {name} from now on.
POST /api/{projectId}/devices/{deviceId}/request-model-update Push a model update to a device · Trigger model update request #
Ask an LLM
“Can I tell a running device to fetch the latest model?”
“Which devices can receive a remote model update request?”
Tell an agent
Trigger a model update on device {device} in project {project}.
Ask device {device} of project {project} to pull the newest model.

Documentation

📖
Documentation
https://docs.edgeimpulse.com/reference/edge-impulse-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/edge-impulse/refs/heads/main/openapi/edge-impulse-devices-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/edge-impulse/refs/heads/main/overlays/edge-impulse-devices-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/edge-impulse:edge-impulse-devices-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

edge-impulse-devices-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Edge Impulse Devices API
  version: 1.0.0
  description: 'Operations tagged Devices across 2 of this provider''s published API definitions: edge-impulse-openapi.yml, edge-impulse-studio-openapi-2026-09-06.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://studio.edgeimpulse.com/v1
tags:
- name: Devices
paths:
  /api/{projectId}/devices:
    get:
      summary: Lists devices
      description: List all devices for this project. Devices get included here if they connect to the remote management API or if they have sent data to the ingestion API and had the `device_id` field set.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      operationId: listDevices
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevicesResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/device/{deviceId}:
    get:
      summary: Get device
      description: Retrieves a single device
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: getDevice
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeviceResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    delete:
      summary: Delete device
      description: Delete a device. When this device sends a new message to ingestion or connects to remote management the device will be recreated.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: deleteDevice
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/device/{deviceId}/start-sampling:
    post:
      summary: Start sampling
      description: Start sampling on a device. This function returns immediately. Updates are streamed through the websocket API.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: startSampling
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSamplingRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartSamplingResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/device/{deviceId}/debug-stream/inference/start:
    post:
      summary: Start inference debug stream
      description: Start an inference debug stream for this device with inference results (and images if a camera is attached). 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).
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: startDeviceInferenceDebugStream
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartDeviceDebugStreamResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/device/{deviceId}/debug-stream/snapshot/start:
    post:
      summary: Start snapshot debug stream
      description: 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).
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: startDeviceSnapshotDebugStream
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDeviceSnapshotDebugStreamRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartDeviceDebugStreamResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/device/{deviceId}/debug-stream/keep-alive:
    post:
      summary: Keep debug stream alive
      description: If you have opened a debug stream, ping this interface every 10 seconds to let us know to keep the debug stream open.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: keepDeviceDebugStreamAlive
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeepDeviceDebugStreamAliveRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/device/{deviceId}/debug-stream/stop:
    post:
      summary: Stop debug stream
      description: If you have opened a debug stream, close it.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: stopDeviceDebugStream
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopDeviceDebugStreamRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/device/{deviceId}/get-impulse-records:
    post:
      summary: Get impulse records
      description: Retrieve impulse records from the device.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: getImpulseRecords
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetImpulseRecordsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/devices/create:
    post:
      summary: Create device
      description: Create a new device. If you set `ifNotExists` to `false` and the device already exists, the `deviceType` will be overwritten.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      operationId: createDevice
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeviceRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/devices/{deviceId}/rename:
    post:
      summary: Rename device
      description: Set the current name for a device.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: renameDevice
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenameDeviceRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
  /api/{projectId}/devices/{deviceId}/request-model-update:
    post:
      summary: Trigger model update request
      description: Trigger a model update request, this only works for devices connected to remote management server in inference mode.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/DeviceIdParameter'
      operationId: requestDeviceModelUpdate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
      security:
      - ApiKeyAuthentication: []
      - JWTAuthentication: []
      - JWTHttpHeaderAuthentication: []
    servers:
    - url: https://studio.edgeimpulse.com/v1
components:
  schemas:
    KeepDeviceDebugStreamAliveRequest:
      type: object
      required:
      - streamId
      properties:
        streamId:
          type: integer
    ListDevicesResponse:
      allOf:
      - $ref: '#/components/schemas/GenericApiResponse'
      - type: object
        required:
        - devices
        properties:
          devices:
            type: array
            items:
              $ref: '#/components/schemas/Device'
    GetImpulseRecordsRequest:
      type: object
      properties:
        index:
          type: integer
        range:
          type: object
          properties:
            first:
              type: integer
            last:
              type: integer
        list:
          type: array
          items:
            type: integer
    StartDeviceDebugStreamResponse:
      allOf:
      - $ref: '#/components/schemas/GenericApiResponse'
      - type: object
        required:
        - streamId
        properties:
          streamId:
            type: integer
    CreateDeviceRequest:
      type: object
      required:
      - deviceId
      - deviceType
      - ifNotExists
      properties:
        deviceId:
          type: string
          description: Globally unique device identifier (e.g. MAC address)
          example: ac:87:a3:0a:2d:1b
        deviceType:
          type: string
          description: Device type, for example the exact model of the device. Should be the same for all similar devices
          example: DISCO_L475VG_IOT01A
        ifNotExists:
          type: boolean
          description: Whether to throw an error when this device already exists.
    StartDeviceSnapshotDebugStreamRequest:
      type: object
      required:
      - resolution
      properties:
        resolution:
          type: string
          enum:
          - high
          - low
    Device:
      type: object
      required:
      - id
      - deviceId
      - created
      - lastSeen
      - name
      - deviceType
      - sensors
      - remote_mgmt_connected
      - supportsSnapshotStreaming
      - remoteMgmtMode
      properties:
        id:
          type: integer
          example: 1
        deviceId:
          type: string
          description: Unique identifier (such as MAC address) for a device
          example: 38:f9:d3:d7:62:03
        created:
          type: string
          format: date-time
          example: '2019-07-21T17:32:28Z'
        lastSeen:
          type: string
          format: date-time
          example: '2019-08-31T17:32:28Z'
          description: Last message that was received from the device (ignoring keep-alive)
        name:
          type: string
          example: m6d.1 desk sensor
        deviceType:
          type: string
          example: DISCO-L475VG
        sensors:
          type: array
          items:
            type: object
            required:
            - name
            - maxSampleLengthS
            - frequencies
            properties:
              name:
                type: string
                example: Built-in accelerometer
              maxSampleLengthS:
                type: integer
                description: Maximum supported sample length in seconds
              frequencies:
                type: array
                description: Supported frequencies for this sensor in Hz.
                example:
                - 62.5
                - 100
                items:
                  type: number
        remote_mgmt_connected:
          type: boolean
          description: Whether the device is connected to the remote management interface. This property is deprecated, use `remoteMgmtMode` instead.
        remote_mgmt_host:
          type: string
          description: The remote management host that the device is connected to
        supportsSnapshotStreaming:
          type: boolean
        remoteMgmtMode:
          description: Replaces `remote_mgmt_connected`. Shows whether the device is connected to the remote management interface, and in which mode.
          type: string
          enum:
          - disconnected
          - ingestion
          - inference
        inferenceInfo:
          type: object
          description: If `remoteMgmtMode` is set to `inference` this object shows information about the model that's ran on device.
          required:
          - projectId
          - projectOwner
          - projectName
          - deployedVersion
          properties:
            projectId:
              type: integer
            projectOwner:
              type: string
            projectName:
              type: string
            deployedVersion:
              type: integer
            modelType:
              type: string
              enum:
              - classification
              - objectDetection
              - constrainedObjectDetection
    GenericApiResponse:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          description: Whether the operation succeeded
        error:
          type: string
          description: Optional error description (set if 'success' was false)
    StartSamplingRequest:
      type: object
      required:
      - label
      - lengthMs
      - category
      - intervalMs
      properties:
        label:
          type: string
          description: Label to be used during sampling.
        lengthMs:
          type: integer
          description: Requested length of the sample (in ms).
        category:
          type: string
          description: Which acquisition category to sample data into.
          enum:
          - training
          - testing
          - anomaly
        intervalMs:
          type: number
          description: Interval between samples (can be calculated like `1/hz * 1000`)
        sensor:
          type: string
          description: The sensor to sample from.
    StartSamplingResponse:
      allOf:
      - $ref: '#/components/schemas/GenericApiResponse'
      - type: object
        properties:
          id:
            type: integer
    GetDeviceResponse:
      allOf:
      - $ref: '#/components/schemas/GenericApiResponse'
      - type: object
        properties:
          device:
            $ref: '#/components/schemas/Device'
    RenameDeviceRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: New name for this device
          example: Jan's development board
    StopDeviceDebugStreamRequest:
      type: object
      required:
      - streamId
      properties:
        streamId:
          type: integer
    StartSamplingRequest_2:
      type: object
      required:
      - label
      - lengthMs
      - category
      - intervalMs
      properties:
        label:
          type: string
          description: Label to be used during sampling.
        lengthMs:
          type: integer
          description: Requested length of the sample (in ms).
        category:
          description: Which acquisition category to sample data into.
          $ref: '#/components/schemas/RawDataCategory'
        intervalMs:
          type: number
          description: Interval between samples (can be calculated like `1/hz * 1000`)
        sensor:
          type: string
          description: The sensor to sample from.
        labelColor:
          type: string
          description: Text color of label displayed on supported clients. Value can be any supported CSS color value
        collectedSampleCount:
          type: number
          description: A hint to supported clients to show the number of samples currently collected
        targetSampleCount:
          type: number
          description: A hint to supported clients to show the desired number of samples to be collected
    RawDataCategory:
      type: string
      enum:
      - training
      - testing
      - validation
      - post-processing
  parameters:
    DeviceIdParameter:
      name: deviceId
      in: path
      required: true
      description: Device ID
      schema:
        type: string
    ProjectIdParameter:
      name: projectId
      in: path
      required: true
      description: Project ID
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuthentication:
      type: apiKey
      in: header
      name: x-api-key
    JWTAuthentication:
      type: apiKey
      in: cookie
      name: jwt
    JWTHttpHeaderAuthentication:
      type: apiKey
      in: header
      name: x-jwt-token
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /v1/oauth/authorize
          tokenUrl: /v1/oauth/token
          scopes:
            openid: Access to basic profile information
            email: Access to email address
            profile: Access to full profile information
        implicit:
          authorizationUrl: /v1/oauth/authorize
          scopes:
            openid: Access to basic profile information
            email: Access to email address
            profile: Access to full profile information
        password:
          tokenUrl: /v1/oauth/token
          scopes:
            openid: Access to basic profile information
            email: Access to email address
            profile: Access to full profile information
        clientCredentials:
          tokenUrl: /v1/oauth/token
          scopes:
            openid: Access to basic profile information
            email: Access to email address
            profile: Access to full profile information
x-refined-from:
- edge-impulse-openapi.yml
- edge-impulse-studio-openapi-2026-09-06.yml