Update transformation block

Update transformation block

post

Updates a transformation block. Only values in the body will be updated.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

organizationIdintegerRequired

Organization ID

transformationIdintegerRequired

Transformation block ID.

Body

namestringOptional

dockerContainerstringOptional

indMetadatabooleanOptional

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

descriptionstringOptional

cliArgumentsstringOptional

requestsCpunumberOptional

requestsMemoryintegerOptional

limitsCpunumberOptional

limitsMemoryintegerOptional

operatesOnstring · enumOptionalPossible values:

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.

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.

sourceCodeDownloadStaffOnlybooleanOptional

Whether the source code is only available for staff users.

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/transformation/{transformationId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 644

{
  "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"
  ],
  "sourceCodeDownloadStaffOnly": true
}

200

OK

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