Impulse

Get impulse blocks

Lists all possible blocks that can be used in the impulse

get/api/{projectId}/impulse/blocks

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/impulse/blocks/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Response

successboolean required

Whether the operation succeeded

errorstring

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

Example response

{
  "inputBlocks": [
    {
      "title": "Time series",
      "author": "Edge Impulse Inc.",
      "name": "Time series"
    }
  ],
  "dspBlocks": [
    {
      "type": "spectral-analysis",
      "title": "Spectral features",
      "author": "Edge Impulse Inc.",
      "name": "Spectral analysis",
      "supportedTargets": [
        "brainchip-akd1000"
      ]
    }
  ],
  "learnBlocks": [
    {
      "title": "Classification",
      "author": "Edge Impulse Inc.",
      "name": "Classification",
      "supportedTargets": [
        "brainchip-akd1000"
      ]
    }
  ],
  "postProcessingBlocks": [
    {
      "title": "Object tracking",
      "author": "Edge Impulse Inc.",
      "name": "Object tracking",
      "supportedTargets": [
        "brainchip-akd1000"
      ],
      "defaultParameters": [
        {
          "name": "Scale axes",
          "type": "text",
          "help": "Divide axes by this number",
          "param": "scale-axes"
        }
      ]
    }
  ]
}

Changes

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