Get impulse blocks

Lists all possible DSP and ML blocks available for this white label.

GET /api/whitelabel/{whitelabelIdentifier}/impulse/blocks

Try it

Get impulse blocks

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/whitelabel/{whitelabelIdentifier}/impulse/blocks \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "inputBlocks": [
    {
      "type": "time-series",
      "title": "Time series",
      "author": "Edge Impulse Inc.",
      "description": "<string>",
      "name": "Time series",
      "blockType": "official"
    }
  ],
  "dspBlocks": [
    {
      "type": "spectral-analysis",
      "title": "Spectral features",
      "author": "Edge Impulse Inc.",
      "description": "<string>",
      "name": "Spectral analysis",
      "recommended": true,
      "experimental": true,
      "latestImplementationVersion": 123,
      "blockType": "official",
      "organizationId": 123,
      "organizationDspId": 123,
      "namedAxes": [
        {
          "name": "<string>",
          "description": "<string>",
          "required": true
        }
      ],
      "supportedTargets": [
        "brainchip-akd1000"
      ]
    }
  ],
  "learnBlocks": [
    {
      "type": "spectral-analysis",
      "title": "Spectral features",
      "author": "Edge Impulse Inc.",
      "description": "<string>",
      "name": "Spectral analysis",
      "recommended": true,
      "blockType": "official",
      "organizationModelId": 123,
      "publicProjectTierAvailability": "enterprise-only",
      "isPublicEnterpriseOnly": true,
      "displayCategory": "classical",
      "supportedTargets": [
        "brainchip-akd1000"
      ]
    }
  ],
  "postProcessingBlocks": [
    {
      "type": "object-tracking",
      "title": "Object tracking",
      "author": "Edge Impulse Inc.",
      "description": "<string>",
      "name": "Object tracking",
      "recommended": true,
      "experimental": true,
      "latestImplementationVersion": 123,
      "blockType": "official",
      "defaultParameters": [
        {
          "name": "Scale axes",
          "defaultValue": "<string>",
          "type": "text",
          "param": "scale-axes",
          "readonly": true,
          "shouldShow": true,
          "required": true,
          "showClickToSet": true,
          "value": "<string>",
          "help": "Divide axes by this number",
          "selectOptions": [
            {
              "value": "<string>",
              "selected": true,
              "optionLabel": "<string>",
              "priority": 123,
              "romEstimate": 123,
              "needsOps": [
                "<string>"
              ],
              "needsFeatures": [
                "<string>"
              ]
            }
          ],
          "showIf": {
            "parameter": "<string>",
            "operator": "eq",
            "value": "<string>"
          },
          "invalidText": "<string>",
          "section": "advanced",
          "multiline": true,
          "hint": "<string>",
          "placeholder": "<string>",
          "valid": [
            {}
          ],
          "items": {},
          "properties": {}
        }
      ],
      "supportedTargets": [
        "brainchip-akd1000"
      ]
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

whitelabelIdentifier · integer · required

Whitelabel ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

inputBlocks · object[] · required

Show child attributes

inputBlocks. type · enum<string> · required

Available options: time-series, image, features

inputBlocks. title · string · required

Example:

"Time series"

inputBlocks. author · string · required

Example:

"Edge Impulse Inc."

inputBlocks. description · string · required

inputBlocks. name · string · required

Example:

"Time series"

inputBlocks. blockType · enum<string> · required

Available options: official, personal, enterprise, pro-or-enterprise, community

dspBlocks · object[] · required

Show child attributes

dspBlocks. type · string · required

Example:

"spectral-analysis"

dspBlocks. title · string · required

Example:

"Spectral features"

dspBlocks. author · string · required

Example:

"Edge Impulse Inc."

dspBlocks. description · string · required

dspBlocks. name · string · required

Example:

"Spectral analysis"

dspBlocks. recommended · boolean · required

dspBlocks. experimental · boolean · required

dspBlocks. latestImplementationVersion · integer · required

dspBlocks. blockType · enum<string> · required

Available options: official, personal, enterprise, pro-or-enterprise, community

dspBlocks. organizationId · integer

dspBlocks. organizationDspId · integer

dspBlocks. namedAxes · object[]

Show child attributes

dspBlocks.namedAxes. name · string · required

dspBlocks.namedAxes. description · string · required

dspBlocks.namedAxes. required · boolean · required

dspBlocks. supportedTargets · string[]

List of target devices that support this DSP block. If undefined this block works on all targets.

learnBlocks · object[] · required

Show child attributes

learnBlocks. type · string · required

Example:

"spectral-analysis"

learnBlocks. title · string · required

Example:

"Spectral features"

learnBlocks. author · string · required

Example:

"Edge Impulse Inc."

learnBlocks. description · string · required

learnBlocks. name · string · required

Example:

"Spectral analysis"

learnBlocks. recommended · boolean · required

learnBlocks. blockType · enum<string> · required

Available options: official, personal, enterprise, pro-or-enterprise, community

learnBlocks. organizationModelId · integer

learnBlocks. publicProjectTierAvailability · enum<string>

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

Available options: enterprise-only, pro-or-enterprise, all-projects

learnBlocks. isPublicEnterpriseOnly · boolean

Whether this block is publicly available to only enterprise users

learnBlocks. displayCategory · enum<string>

Category to display this block in the UI.

Available options: classical, tao, developer-preview

learnBlocks. supportedTargets · string[]

List of target devices that support this learn block. If undefined this block works on all targets.

postProcessingBlocks · object[] · required

Show child attributes

postProcessingBlocks. type · string · required

Example:

"object-tracking"

postProcessingBlocks. title · string · required

Example:

"Object tracking"

postProcessingBlocks. author · string · required

Example:

"Edge Impulse Inc."

postProcessingBlocks. description · string · required

postProcessingBlocks. name · string · required

Example:

"Object tracking"

postProcessingBlocks. recommended · boolean · required

postProcessingBlocks. experimental · boolean · required

postProcessingBlocks. latestImplementationVersion · integer · required

postProcessingBlocks. blockType · enum<string> · required

Available options: official, personal, enterprise, pro-or-enterprise, community

postProcessingBlocks. defaultParameters · object[] · required

Show child attributes

postProcessingBlocks.defaultParameters. name · string · required

Example:

"Scale axes"

postProcessingBlocks.defaultParameters. defaultValue · string · required

postProcessingBlocks.defaultParameters. type · string · required

Example:

"text"

postProcessingBlocks.defaultParameters. param · string · required

Example:

"scale-axes"

postProcessingBlocks.defaultParameters. readonly · boolean · required

postProcessingBlocks.defaultParameters. shouldShow · boolean · required

postProcessingBlocks.defaultParameters. required · boolean · required

postProcessingBlocks.defaultParameters. showClickToSet · boolean · required

If enabled, render a disabled input element with 'Click to set'

postProcessingBlocks.defaultParameters. value · string

postProcessingBlocks.defaultParameters. help · string

Example:

"Divide axes by this number"

postProcessingBlocks.defaultParameters. selectOptions · object[]

Show child attributes

postProcessingBlocks.defaultParameters.selectOptions. value · string

What is the string that will be set if this option is selected?

postProcessingBlocks.defaultParameters.selectOptions. selected · boolean

postProcessingBlocks.defaultParameters.selectOptions. optionLabel · string

What is the label that will be shown to the user for this option?

postProcessingBlocks.defaultParameters.selectOptions. priority · number

The following options are optional. See Learn Block Auto Config in Notion. Higher priority will get chosen based on limits below.

postProcessingBlocks.defaultParameters.selectOptions. romEstimate · number

Estimated ROM footprint for this choice. Will be tested against ROM budget in Studio.

postProcessingBlocks.defaultParameters.selectOptions. needsOps · string[]

ML operator needed by this choice.

postProcessingBlocks.defaultParameters.selectOptions. needsFeatures · string[]

Feature needed by this choice. (non op related)

postProcessingBlocks.defaultParameters. showIf · object

Show child attributes

postProcessingBlocks.defaultParameters.showIf. parameter · string · required

postProcessingBlocks.defaultParameters.showIf. operator · enum<string> · required

Available options: eq, neq

postProcessingBlocks.defaultParameters.showIf. value · string · required

postProcessingBlocks.defaultParameters. invalidText · string

postProcessingBlocks.defaultParameters. section · enum<string>

Interface section to render parameter in.

Available options: advanced, augmentation, modelProfiling

postProcessingBlocks.defaultParameters. multiline · boolean

Only valid for type "string". Will render a multiline text area.

postProcessingBlocks.defaultParameters. hint · string

If set, shows a hint below the input.

postProcessingBlocks.defaultParameters. placeholder · string

Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")

postProcessingBlocks.defaultParameters. valid · object[]

Valid values for parameter.

postProcessingBlocks.defaultParameters. items · object

Recursive definition for items of a parameter with type 'array'.

postProcessingBlocks.defaultParameters. properties · object

Recursive definition for a parameter with type 'object'.

postProcessingBlocks. supportedTargets · string[]

List of target devices that support this DSP block. If undefined this block works on all targets.

error · string

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