---
title: "Get impulse blocks"
method: GET
path: "/api/whitelabel/{whitelabelIdentifier}/impulse/blocks"
tags: ["Whitelabels"]
---

# Get impulse blocks

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

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/whitelabel/{whitelabelIdentifier}/impulse/blocks`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - 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/whitelabel/:whitelabelIdentifier/impulse/blocks/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `whitelabelIdentifier` integer, required

## Response `200`

OK

- GetImpulseBlocksResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `inputBlocks` InputBlock[], required
    - `type` 'time-series' | 'image' | 'features', required
    - `title` string, required
    - `author` string, required
    - `description` string, required
    - `name` string, required
    - `blockType` 'official' | 'personal' | 'enterprise' | 'community', required
  - `dspBlocks` DSPBlock[], required
    - `type` string, required
    - `title` string, required
    - `author` string, required
    - `description` string, required
    - `name` string, required
    - `recommended` boolean, required
    - `experimental` boolean, required
    - `latestImplementationVersion` integer, required
    - `organizationId` integer
    - `organizationDspId` integer
    - `blockType` 'official' | 'personal' | 'enterprise' | 'community', required
    - `namedAxes` DSPNamedAxis[]
      - `name` string, required
      - `description` string, required
      - `required` boolean, required
    - `supportedTargets` string[]: List of target devices that support this DSP block. If undefined this block works on all targets.
  - `learnBlocks` LearnBlock[], required
    - `type` 'anomaly' | 'anomaly-gmm' | 'keras' | 'keras-transfer-image' | 'keras-transfer-kws' | 'keras-object-detection' | 'keras-regression' | 'keras-akida' | 'keras-akida-transfer-image' | 'keras-akida-object-detection' | 'keras-visual-anomaly' | 'keras-freeform' | 'keras-self-contained-freeform' | 'keras-anomaly' | 'vlm', required: The type of learning block (anomaly, keras, keras-transfer-image, ...). Each behaves differently.
    - `title` string, required
    - `author` string, required
    - `description` string, required
    - `name` string, required
    - `recommended` boolean, required
    - `organizationModelId` integer
    - `publicProjectTierAvailability` 'enterprise-only' | 'all-projects' | 'all-projects-including-whitelabels': For public blocks, this indicates the project tiers for which this block is available.
    - `isPublicEnterpriseOnly` boolean: Whether this block is publicly available to only enterprise users
    - `blockType` 'official' | 'personal' | 'enterprise' | 'community', required
    - `displayCategory` 'classical' | 'tao' | 'developer-preview': Category to display this block in the UI.
    - `supportedTargets` string[]: List of target devices that support this learn block. If undefined this block works on all targets.
  - `postProcessingBlocks` PostProcessingBlock[], required
    - `type` 'object-tracking' | 'sort-object-tracking', required
    - `title` string, required
    - `author` string, required
    - `description` string, required
    - `name` string, required
    - `recommended` boolean, required
    - `experimental` boolean, required
    - `latestImplementationVersion` integer, required
    - `blockType` 'official' | 'personal' | 'enterprise' | 'community', required
    - `supportedTargets` string[]: List of target devices that support this DSP block. If undefined this block works on all targets.
    - `defaultParameters` DSPGroupItem[], required
      - `name` string, required
      - `value` string
      - `defaultValue` string, required
      - `type` string, required
      - `help` string
      - `param` string, required
      - `selectOptions` object[]
        - `value` string: What is the string that will be set if this option is selected?
        - `selected` boolean
        - `optionLabel` string: What is the label that will be shown to the user for this option?
        - `priority` number: The following options are optional. See Learn Block Auto Config in Notion. Higher priority will get chosen based on limits below.
        - `romEstimate` number: Estimated ROM footprint for this choice. Will be tested against ROM budget in Studio.
        - `needsOps` string[]
        - `needsFeatures` string[]
      - `readonly` boolean, required
      - `shouldShow` boolean, required
      - `showIf` object
        - `parameter` string, required
        - `operator` 'eq' | 'neq', required
        - `value` string, required
      - `invalidText` string
      - `section` 'advanced' | 'augmentation' | 'modelProfiling': Interface section to render parameter in.
      - `multiline` boolean: Only valid for type "string". Will render a multiline text area.
      - `required` boolean, required
      - `hint` string: If set, shows a hint below the input.
      - `placeholder` string: Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")
      - `showClickToSet` boolean, required: If enabled, render a disabled input element with 'Click to set'
      - `valid` object[]: Valid values for parameter.
      - `items` object: Recursive definition for items of a parameter with type 'array'.
      - `properties` object: Recursive definition for a parameter with type 'object'.
      - `minVal` number: Minimum value for parameters of type 'int' or 'float'.
      - `maxVal` number: Maximum value for parameters of type 'int' or 'float'.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)