Update block version details

Update block version details

Update the details of a block version

PUThttps://studio.edgeimpulse.com/v1/api/{projectId}/impulse/block-versions/{blockType}/{blockId}

Path parameters

projectId*integer

Project ID

blockType*string

Type of block

blockId*integer

Block ID

Body

application/json

idinteger

Identifier for the new block version. Make sure to up this number when creating a new block, and don't re-use identifiers.

primaryVersionboolean

Whether this block is the primary version of its base block.

namestring

Block name, will be used in menus. If a block has a baseBlockId, this field is ignored and the base block's name is used instead.

Example: "NN Classifier"

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

dsparray of integer

(Learn only) DSP dependencies, identified by DSP block ID

axesarray of string

(DSP only) Input axes, identified by the name in the name of the axis

inputinteger

(DSP only) The ID of the Input block a DSP block is connected to

Example: 1

windowSizeMsinteger

(Input only) Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

(Input only) We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

(Input only) We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

(Input only) Whether to zero pad data when there is not enough data.

imageWidthinteger

(Input only) Width all images are resized to before training

Example: 28

imageHeightinteger

(Input only) Width all images are resized to before training

Example: 28

resizeModeenum

(Input only) How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

(Input only) Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

(Input only) If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/impulse/block-versions/{blockType}/{blockId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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