---
title: "Get transformation block"
method: GET
path: "/api/organizations/{organizationId}/transformation/{transformationId}"
tags: ["OrganizationBlocks"]
---

# Get transformation block

`GET /api/organizations/{organizationId}/transformation/{transformationId}`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transformation/{transformationId}`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - 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/:transformationId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a transformation block.

## Path parameters

- `organizationId` integer, required
- `transformationId` integer, required

## Response `200`

OK

- GetOrganizationTransformationBlockResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `transformationBlock` OrganizationTransformationBlock, required
    - `id` integer, required
    - `name` string, required
    - `dockerContainer` string, required
    - `dockerContainerManagedByEdgeImpulse` boolean, required
    - `created` string, date-time, required
    - `createdByUser` CreatedUpdatedByUser
      - `id` integer, required
      - `name` string, required
      - `username` string, required
      - `photo` string
    - `lastUpdated` string, date-time
    - `lastUpdatedByUser` CreatedUpdatedByUser
      - `id` integer, required
      - `name` string, required
      - `username` string, required
      - `photo` string
    - `userId` integer
    - `userName` string
    - `description` string, required
    - `cliArguments` string, required: These arguments are passed into the container
    - `indMetadata` boolean, required
    - `requestsCpu` number
    - `requestsMemory` integer
    - `limitsCpu` number
    - `limitsMemory` integer
    - `additionalMountPoints` TransformationBlockAdditionalMountPoint[], required
      - `type` 'bucket' | 'portal', required
      - `bucketId` integer
      - `portalId` integer
      - `mountPoint` string, required
    - `operatesOn` 'file' | 'directory' | 'standalone', required
    - `allowExtraCliArguments` boolean, required
    - `parameters` object[]: List of parameters, spec'ed according to https://docs.edgeimpulse.com/docs/tips-and-tricks/adding-parameters-to-custom-blocks
    - `parametersUI` DSPGroupItem[]: List of parameters to be rendered in the UI
      - `name` string, required
      - `value` string
      - `defaultValue` string, required
      - `type` string, required
      - `help` string
      - `param` string, required
      - `selectOptions` object[]
        - `value` string: What is the string that will be set if this option is selected?
        - `selected` boolean
        - `optionLabel` string: What is the label that will be shown to the user for this option?
        - `priority` number: The following options are optional. See Learn Block Auto Config in Notion. Higher priority will get chosen based on limits below.
        - `romEstimate` number: Estimated ROM footprint for this choice. Will be tested against ROM budget in Studio.
        - `needsOps` string[]
        - `needsFeatures` string[]
      - `readonly` boolean, required
      - `shouldShow` boolean, required
      - `showIf` object
        - `parameter` string, required
        - `operator` 'eq' | 'neq', required
        - `value` string, required
      - `invalidText` string
      - `section` 'advanced' | 'augmentation' | 'modelProfiling': Interface section to render parameter in.
      - `multiline` boolean: Only valid for type "string". Will render a multiline text area.
      - `required` boolean, required
      - `hint` string: If set, shows a hint below the input.
      - `placeholder` string: Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")
      - `showClickToSet` boolean, required: If enabled, render a disabled input element with 'Click to set'
      - `valid` object[]: Valid values for parameter.
      - `items` object: Recursive definition for items of a parameter with type 'array'.
      - `properties` object: Recursive definition for a parameter with type 'object'.
      - `minVal` number: Minimum value for parameters of type 'int' or 'float'.
      - `maxVal` number: Maximum value for parameters of type 'int' or 'float'.
    - `maxRunningTimeStr` string: 15m for 15 minutes, 2h for 2 hours, 1d for 1 day. If not set, the default is 8 hours.
    - `sourceCodeAvailable` boolean, required
    - `sourceCodeDownloadStaffOnly` boolean, required: Whether the source code is only available for staff users.
    - `repositoryUrl` string: URL to the source code of this custom learn block.
    - `isPublic` boolean, required: Whether this block is publicly available to Edge Impulse users (if false, then only for members of the owning organization)
    - `publicProjectTierAvailability` 'enterprise-only' | 'all-projects' | 'all-projects-including-whitelabels', required: For public blocks, this indicates the project tiers for which this block is available.
    - `showInDataSources` boolean, required: Whether to show this block in 'Data sources'. Only applies for standalone blocks.
    - `showInCreateTransformationJob` boolean, required: Whether to show this block in 'Create transformation job'. Only applies for standalone blocks.
    - `showInSyntheticData` boolean, required: Whether to show this block in 'Synthetic data'. Only applies for standalone blocks.
    - `showInAIActions` boolean, required: Whether to show this block in 'AI Labeling'. Only applies for standalone blocks.
    - `environmentVariables` EnvironmentVariable[], required: Extra environmental variables that are passed into the transformation block (key/value pairs).
      - `key` string, required: Environmental variable key. Needs to adhere to regex "^[a-zA-Z_]+[a-zA-Z0-9_]*$".
      - `value` string: If value is left undefined, only the key is passed in as an environmental variable.
    - `aiActionsOperatesOn` AIActionsOperatesOn[]: 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.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)