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

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

Body

application/json
name
string
required
dockerContainer
string
required
indMetadata
boolean
required

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

description
string
required
cliArguments
string
required
additionalMountPoints
object[]
required
operatesOn
enum<string>
required
Available options:
file,
directory,
dataitem,
standalone
requestsCpu
number
requestsMemory
integer
limitsCpu
number
limitsMemory
integer
allowExtraCliArguments
boolean
parameters
object[]
maxRunningTimeStr
string

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

isPublic
boolean
repositoryUrl
string

URL to the source code of this custom learn block.

showInDataSources
boolean

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

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
object[]
aiActionsOperatesOn
enum<string>[]

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.

sourceCodeDownloadStaffOnly
boolean

Whether the source code is only available for staff users.

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

id
integer
required

Unique identifier of the created entity.

error
string

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