OrganizationBlocks

Add transformation block

Adds a transformation block.

post/api/organizations/{organizationId}/transformation

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/transformation/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

Request body

namestring required

dockerContainerstring required

indMetadataboolean required

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

descriptionstring required

cliArgumentsstring required

requestsCpunumber

requestsMemoryinteger

limitsCpunumber

limitsMemoryinteger

operatesOn'file' | 'directory' | 'dataitem' | 'standalone' required

allowExtraCliArgumentsboolean

parametersobject[]

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

publicProjectTierAvailability'enterprise-only' | 'all-projects' | 'all-projects-including-whitelabels'

For public blocks, this indicates the project tiers for which this block is available.

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.

aiActionsOperatesOnAIActionsOperatesOn[]

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.

sourceCodeDownloadStaffOnlyboolean

Whether the source code is only available for staff users.

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Unique identifier of the created entity.

Changes

No recorded changes to this operation across all 1 revision of this API.