Get transformation blocks

Retrieve all transformation blocks.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transformation

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

transformationBlocks*array of OrganizationTransformationBlock (object)

id*integer

name*string

dockerContainer*string

dockerContainerManagedByEdgeImpulse*boolean

created*string (date-time)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

lastUpdatedstring (date-time)

lastUpdatedByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

userIdinteger

userNamestring

description*string

cliArguments*string

These arguments are passed into the container

indMetadata*boolean

requestsCpunumber

requestsMemoryinteger

limitsCpunumber

limitsMemoryinteger

additionalMountPoints*array of TransformationBlockAdditionalMountPoint (object)

type*enum

bucketportal

bucketIdinteger

portalIdinteger

mountPoint*string

operatesOn*TransformationJobOperatesOnEnum (enum)

filedirectorystandalone

allowExtraCliArguments*boolean

parametersarray of object

List of parameters, spec'ed according to https://docs.edgeimpulse.com/docs/tips-and-tricks/adding-parameters-to-custom-blocks

parametersUIarray of DSPGroupItem (object)

List of parameters to be rendered in the UI

name*string

Example: "Scale axes"

valuestring

defaultValue*string

type*string

Example: "text"

helpstring

Example: "Divide axes by this number"

param*string

Example: "scale-axes"

selectOptionsarray of object

valuestring

selectedboolean

optionLabelstring

readonly*boolean

shouldShow*boolean

showIfobject

parameter*string

operator*enum

eqneq

value*string

invalidTextstring

sectionenum

Interface section to render parameter in.

advancedaugmentationmodelProfiling

multilineboolean

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

required*boolean

hintstring

If set, shows a hint below the input.

placeholderstring

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

maxRunningTimeStrstring

15m for 15 minutes, 2h for 2 hours, 1d for 1 day. If not set, the default is 8 hours.

sourceCodeAvailable*boolean

repositoryUrlstring

URL to the source code of this custom learn block.

isPublic*boolean

Whether this block is publicly available to Edge Impulse users (if false, then only for members of the owning organization)

showInDataSources*boolean

Whether to show this block in 'Data sources'. Only applies for standalone blocks.

showInCreateTransformationJob*boolean

Whether to show this block in 'Create transformation job'. Only applies for standalone blocks.

showInSyntheticData*boolean

Whether to show this block in 'Synthetic data'. Only applies for standalone blocks.

showInAIActions*boolean

Whether to show this block in 'AI Labeling'. Only applies for standalone blocks.

environmentVariables*array of EnvironmentVariable (object)

Extra environmental variables that are passed into the transformation block (key/value pairs).

key*string

Environmental variable key. Needs to adhere to regex "^[a-zA-Z_]+[a-zA-Z0-9_]*$".

valuestring

If value is left undefined, only the key is passed in as an environmental variable.

aiActionsOperatesOnarray of AIActionsOperatesOn (enum)

For AI labeling blocks, this lists the data types that the block supports. If this field is empty then there's no information about supported data types.

itemsAIActionsOperatesOn (enum)

images_object_detectionimages_single_labelaudioother

Request

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

Response

{
  "success": false,
  "error": "text",
  "transformationBlocks": [
    {
      "id": 0,
      "name": "text",
      "dockerContainer": "text",
      "dockerContainerManagedByEdgeImpulse": false,
      "created": "2024-12-03T17:13:54.024Z",
      "createdByUser": {
        "id": 0,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "lastUpdated": "2024-12-03T17:13:54.024Z",
      "lastUpdatedByUser": {
        "id": 0,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "userId": 0,
      "userName": "text",
      "description": "text",
      "cliArguments": "text",
      "indMetadata": false,
      "requestsCpu": 0,
      "requestsMemory": 0,
      "limitsCpu": 0,
      "limitsMemory": 0,
      "additionalMountPoints": [
        {
          "type": "bucket",
          "bucketId": 0,
          "portalId": 0,
          "mountPoint": "text"
        }
      ],
      "operatesOn": "file",
      "allowExtraCliArguments": false,
      "parameters": [],
      "parametersUI": [
        {
          "name": "Scale axes",
          "value": "text",
          "defaultValue": "text",
          "type": "text",
          "help": "Divide axes by this number",
          "param": "scale-axes",
          "selectOptions": [
            {
              "value": "text",
              "selected": false,
              "optionLabel": "text"
            }
          ],
          "readonly": false,
          "shouldShow": false,
          "showIf": {
            "parameter": "text",
            "operator": "eq",
            "value": "text"
          },
          "invalidText": "text",
          "section": "advanced",
          "multiline": false,
          "required": false,
          "hint": "text",
          "placeholder": "text"
        }
      ],
      "maxRunningTimeStr": "text",
      "sourceCodeAvailable": false,
      "repositoryUrl": "text",
      "isPublic": false,
      "showInDataSources": false,
      "showInCreateTransformationJob": false,
      "showInSyntheticData": false,
      "showInAIActions": false,
      "environmentVariables": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "aiActionsOperatesOn": [
        "images_object_detection"
      ]
    }
  ]
}