Add transformation block

Add transformation block

post

Adds a transformation block.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

Body

namestringrequired

dockerContainerstringrequired

indMetadatabooleanrequired

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

descriptionstringrequired

cliArgumentsstringrequired

requestsCpunumberoptional

requestsMemoryintegeroptional

limitsCpunumberoptional

limitsMemoryintegeroptional

additionalMountPointsobject[]required

operatesOnstring · enumrequired

Options: file, directory, dataitem, standalone

allowExtraCliArgumentsbooleanoptional

parametersobject[]optional

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

maxRunningTimeStrstringoptional

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

isPublicbooleanoptional

repositoryUrlstringoptional

URL to the source code of this custom learn block.

showInDataSourcesbooleanoptional

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

showInCreateTransformationJobbooleanoptional

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

showInSyntheticDatabooleanoptional

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

showInAIActionsbooleanoptional

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

environmentVariablesobject[]optional

aiActionsOperatesOnstring · enum[]optional

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transformation' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "dockerContainer": "text",
    "indMetadata": true,
    "description": "text",
    "cliArguments": "text",
    "requestsCpu": 1,
    "requestsMemory": 1,
    "limitsCpu": 1,
    "limitsMemory": 1,
    "additionalMountPoints": [
      {
        "type": "bucket",
        "bucketId": 1,
        "portalId": 1,
        "mountPoint": "text"
      }
    ],
    "operatesOn": "file",
    "allowExtraCliArguments": true,
    "parameters": [
      {}
    ],
    "maxRunningTimeStr": "text",
    "isPublic": true,
    "repositoryUrl": "text",
    "showInDataSources": true,
    "showInCreateTransformationJob": true,
    "showInSyntheticData": true,
    "showInAIActions": true,
    "environmentVariables": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "aiActionsOperatesOn": [
      "images_object_detection"
    ]
  }'

200

200

{
  "success": true,
  "error": "text",
  "id": 1
}

OK