Add transformation block

Add transformation block

Adds a transformation block.

post

/api/organizations/{organizationId}/transformation

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

Body

namestringrequired

dockerContainerstringrequired

indMetadatabooleanrequired

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

descriptionstringrequired

cliArgumentsstringrequired

requestsCpunumber

requestsMemoryinteger

limitsCpunumber

limitsMemoryinteger

allowExtraCliArgumentsboolean

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.

operatesOnstring · enumrequired

Options: file, directory, dataitem, standalone

additionalMountPointsobject[]required

parametersobject[]

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

environmentVariablesobject[]

aiActionsOperatesOnstring · 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.

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","operatesOn":"file","additionalMountPoints":[{"mountPoint":"text","type":"bucket"}],"parameters":[{}],"environmentVariables":[{"key":"text"}],"aiActionsOperatesOn":["images_object_detection"]}'

200

200

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

OK