1 of 4

Whitelabels

Get white label domain

Update deployment targets

Get impulse blocks

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

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

Path parameters

whitelabelIdentifier*integer

Whitelabel 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

Response

Get white label domain

Get a white label domain given its unique identifier.

GEThttps://studio.edgeimpulse.com/v1/api/whitelabel/{whitelabelIdentifier}/domain

Path parameters

whitelabelIdentifier*integer

Whitelabel ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

domain*string

logostring

Request

Response

Get white label domain

Get a white label domain given its unique identifier.

GEThttps://studio.edgeimpulse.com/v1/api/whitelabel/{whitelabelIdentifier}/domain

Path parameters

whitelabelIdentifier*integer

Whitelabel ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

domain*string

logostring

Request

Response

Get impulse blocks

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

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

Path parameters

whitelabelIdentifier*integer

Whitelabel 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

Response

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

{
  "success": false,
  "error": "text",
  "domain": "text",
  "logo": "text"
}

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

{
  "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"
    }
  ]
}

Update deployment targets

Update some or all of the deployment targets enabled for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/whitelabel/{whitelabelIdentifier}/deploymentTargets

Path parameters

whitelabelIdentifier*integer

Whitelabel ID

Body

targetsarray of string

The names of the deployment targets that are enabled for this whitelabel.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

Update deployment targets

Update some or all of the deployment targets enabled for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/whitelabel/{whitelabelIdentifier}/deploymentTargets

Path parameters

whitelabelIdentifier*integer

Whitelabel ID

Body

targetsarray of string

The names of the deployment targets that are enabled for this whitelabel.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/whitelabel/{whitelabelIdentifier}/deploymentTargets', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "success": false,
  "error": "text"
}