Add transformation block

Add transformation block

Adds a transformation block.

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

Path parameters

organizationId*integer

Organization ID

Body

application/json

name*string

dockerContainer*string

indMetadata*boolean

Whether to pass the --metadata parameter to the container.

description*string

cliArguments*string

requestsCpunumber

requestsMemoryinteger

limitsCpunumber

limitsMemoryinteger

additionalMountPoints*array of TransformationBlockAdditionalMountPoint (object)

operatesOn*enum

filedirectorydataitemstandalone

allowExtraCliArgumentsboolean

parametersarray of object

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

maxRunningTimeStrstring

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

isPublicboolean

repositoryUrlstring

URL to the source code of this custom learn block.

showInDataSourcesboolean

Whether to show this block in 'Data sources'. Only applies for standalone blocks. (defaults to 'true' when not provided)

showInCreateTransformationJobboolean

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

showInSyntheticDataboolean

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

showInAIActionsboolean

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

environmentVariablesarray of EnvironmentVariable (object)

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.

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Unique identifier of the created entity.

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transformation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "dockerContainer": "text",
      "indMetadata": false,
      "description": "text",
      "cliArguments": "text",
      "additionalMountPoints": [
        {
          "type": "bucket",
          "mountPoint": "text"
        }
      ],
      "operatesOn": "file"
    }),
});
const data = await response.json();

Response

200

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