STUDIO API ENDPOINTS
- GETGet transformation blocks
- POSTAdd transformation block
- GETList public transformation blocks
- GETGet public transformation block
- GETGet transformation block
- POSTUpdate transformation block
- DELDelete transformation block
- POSTExport transformation block
- GETGet deploy blocks
- POSTAdd deploy block
- GETGet deploy block
- POSTUpdate deploy block
- DELDelete deploy block
- POSTExport deploy block
- GETGet dsp blocks
- POSTAdd dsp block
- GETGet dsp block
- POSTUpdate dsp block
- DELDelete dsp block
- POSTExport dsp block
- POSTRetry connection to dsp block
- GETGet transfer learning blocks
- POSTAdd transfer learning block
- GETGet transfer learning block
- POSTUpdate transfer learning block
- DELDelete transfer learning block
- POSTExport transfer learning block
- GETGet secrets
- POSTAdd secret
- DELDelete secret
- GET
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transformation \
--header 'x-api-key: <api-key>'{
"success": true,
"transformationBlocks": [
{
"id": 123,
"name": "<string>",
"dockerContainer": "<string>",
"dockerContainerManagedByEdgeImpulse": true,
"created": "2023-11-07T05:31:56Z",
"description": "<string>",
"cliArguments": "<string>",
"indMetadata": true,
"additionalMountPoints": [
{
"type": "bucket",
"mountPoint": "<string>",
"bucketId": 123,
"portalId": 123
}
],
"operatesOn": "file",
"allowExtraCliArguments": true,
"sourceCodeAvailable": true,
"sourceCodeDownloadStaffOnly": true,
"isPublic": true,
"showInDataSources": true,
"showInCreateTransformationJob": true,
"showInSyntheticData": true,
"showInAIActions": true,
"environmentVariables": [
{
"key": "<string>",
"value": "<string>"
}
],
"createdByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
},
"lastUpdated": "2023-11-07T05:31:56Z",
"lastUpdatedByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
},
"userId": 123,
"userName": "<string>",
"requestsCpu": 123,
"requestsMemory": 123,
"limitsCpu": 123,
"limitsMemory": 123,
"parameters": [
{}
],
"parametersUI": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {}
}
],
"maxRunningTimeStr": "<string>",
"repositoryUrl": "<string>",
"aiActionsOperatesOn": [
"images_object_detection"
]
}
],
"error": "<string>"
}Get transformation blocks
Retrieve all transformation blocks.
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transformation \
--header 'x-api-key: <api-key>'{
"success": true,
"transformationBlocks": [
{
"id": 123,
"name": "<string>",
"dockerContainer": "<string>",
"dockerContainerManagedByEdgeImpulse": true,
"created": "2023-11-07T05:31:56Z",
"description": "<string>",
"cliArguments": "<string>",
"indMetadata": true,
"additionalMountPoints": [
{
"type": "bucket",
"mountPoint": "<string>",
"bucketId": 123,
"portalId": 123
}
],
"operatesOn": "file",
"allowExtraCliArguments": true,
"sourceCodeAvailable": true,
"sourceCodeDownloadStaffOnly": true,
"isPublic": true,
"showInDataSources": true,
"showInCreateTransformationJob": true,
"showInSyntheticData": true,
"showInAIActions": true,
"environmentVariables": [
{
"key": "<string>",
"value": "<string>"
}
],
"createdByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
},
"lastUpdated": "2023-11-07T05:31:56Z",
"lastUpdatedByUser": {
"id": 123,
"name": "<string>",
"username": "<string>",
"photo": "<string>"
},
"userId": 123,
"userName": "<string>",
"requestsCpu": 123,
"requestsMemory": 123,
"limitsCpu": 123,
"limitsMemory": 123,
"parameters": [
{}
],
"parametersUI": [
{
"name": "Scale axes",
"defaultValue": "<string>",
"type": "text",
"param": "scale-axes",
"readonly": true,
"shouldShow": true,
"required": true,
"showClickToSet": true,
"value": "<string>",
"help": "Divide axes by this number",
"selectOptions": [
{
"value": "<string>",
"selected": true,
"optionLabel": "<string>",
"priority": 123,
"romEstimate": 123,
"needsOps": [
"<string>"
],
"needsFeatures": [
"<string>"
]
}
],
"showIf": {
"parameter": "<string>",
"operator": "eq",
"value": "<string>"
},
"invalidText": "<string>",
"section": "advanced",
"multiline": true,
"hint": "<string>",
"placeholder": "<string>",
"valid": [
{}
],
"items": {},
"properties": {}
}
],
"maxRunningTimeStr": "<string>",
"repositoryUrl": "<string>",
"aiActionsOperatesOn": [
"images_object_detection"
]
}
],
"error": "<string>"
}Authorizations
Path Parameters
Organization ID
Response
OK
Whether the operation succeeded
Show child attributes
Show child attributes
These arguments are passed into the container
Show child attributes
Show child attributes
file, directory, standalone Whether the source code is only available for staff users.
Whether this block is publicly available to Edge Impulse users (if false, then only for members of the owning organization)
Whether to show this block in 'Data sources'. Only applies for standalone blocks.
Whether to show this block in 'Create transformation job'. Only applies for standalone blocks.
Whether to show this block in 'Synthetic data'. Only applies for standalone blocks.
Whether to show this block in 'AI Labeling'. Only applies for standalone blocks.
Extra environmental variables that are passed into the transformation block (key/value pairs).
List of parameters, spec'ed according to https://docs.edgeimpulse.com/docs/tips-and-tricks/adding-parameters-to-custom-blocks
List of parameters to be rendered in the UI
Show child attributes
Show child attributes
"Scale axes"
"text"
"scale-axes"
If enabled, render a disabled input element with 'Click to set'
"Divide axes by this number"
Show child attributes
Show child attributes
What is the string that will be set if this option is selected?
What is the label that will be shown to the user for this option?
The following options are optional. See Learn Block Auto Config in Notion. Higher priority will get chosen based on limits below.
Estimated ROM footprint for this choice. Will be tested against ROM budget in Studio.
ML operator needed by this choice.
Feature needed by this choice. (non op related)
Interface section to render parameter in.
advanced, augmentation, modelProfiling Only valid for type "string". Will render a multiline text area.
If set, shows a hint below the input.
Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")
Valid values for parameter.
Recursive definition for items of a parameter with type 'array'.
Recursive definition for a parameter with type 'object'.
15m for 15 minutes, 2h for 2 hours, 1d for 1 day. If not set, the default is 8 hours.
URL to the source code of this custom learn block.
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.
images_object_detection, images_single_label, audio, other Optional error description (set if 'success' was false)
Was this page helpful?