Get impulse blocks

Lists all possible blocks that can be used in the impulse

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/impulse/blocks

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

inputBlocks*array of InputBlock (object)

type*enum

time-seriesimagefeatures

title*string

Example: "Time series"

author*string

Example: "Edge Impulse Inc."

description*string

name*string

Example: "Time series"

recommendedboolean

blockType*BlockType (enum)

officialpersonalenterprisepro-or-enterprisecommunity

dspBlocks*array of DSPBlock (object)

type*string

Example: "spectral-analysis"

title*string

Example: "Spectral features"

author*string

Example: "Edge Impulse Inc."

description*string

name*string

Example: "Spectral analysis"

recommendedboolean

experimental*boolean

latestImplementationVersion*integer

organizationIdinteger

organizationDspIdinteger

blockType*BlockType (enum)

officialpersonalenterprisepro-or-enterprisecommunity

namedAxesarray of DSPNamedAxis (object)

name*string

description*string

required*boolean

learnBlocks*array of LearnBlock (object)

type*string

Example: "spectral-analysis"

title*string

Example: "Spectral features"

author*string

Example: "Edge Impulse Inc."

description*string

name*string

Example: "Spectral analysis"

recommendedboolean

organizationModelIdinteger

publicProjectTierAvailabilityPublicProjectTierAvailability (enum)

For public blocks, this indicates the project tiers for which this block is available.

enterprise-onlypro-or-enterpriseall-projects

isPublicEnterpriseOnlyboolean

Whether this block is publicly available to only enterprise users

blockType*BlockType (enum)

officialpersonalenterprisepro-or-enterprisecommunity

displayCategoryBlockDisplayCategory (enum)

Category to display this block in the UI.

classicaltao

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/impulse/blocks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "inputBlocks": [
    {
      "type": "time-series",
      "title": "Time series",
      "author": "Edge Impulse Inc.",
      "description": "text",
      "name": "Time series",
      "recommended": false,
      "blockType": "official"
    }
  ],
  "dspBlocks": [
    {
      "type": "spectral-analysis",
      "title": "Spectral features",
      "author": "Edge Impulse Inc.",
      "description": "text",
      "name": "Spectral analysis",
      "recommended": false,
      "experimental": false,
      "blockType": "official",
      "namedAxes": [
        {
          "name": "text",
          "description": "text",
          "required": false
        }
      ]
    }
  ],
  "learnBlocks": [
    {
      "type": "spectral-analysis",
      "title": "Spectral features",
      "author": "Edge Impulse Inc.",
      "description": "text",
      "name": "Spectral analysis",
      "recommended": false,
      "publicProjectTierAvailability": "enterprise-only",
      "isPublicEnterpriseOnly": false,
      "blockType": "official",
      "displayCategory": "classical"
    }
  ]
}