Get post-processing block config

Retrieve the configuration parameters for a post-processing block. Use the impulse functions to retrieve all post-processing blocks.

GET /api/{projectId}/post-processing/{postProcessingId}

Try it

Get post-processing block config

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/post-processing/{postProcessingId} \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "enabled": true,
  "parameters": [
    {
      "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": {}
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

postProcessingId · integer · required

Post-processing Block ID, use the impulse functions to retrieve the ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

enabled · boolean · required

parameters · object[] · required

Show child attributes

parameters. name · string · required

Example:

"Scale axes"

parameters. defaultValue · string · required

parameters. type · string · required

Example:

"text"

parameters. param · string · required

Example:

"scale-axes"

parameters. readonly · boolean · required

parameters. shouldShow · boolean · required

parameters. required · boolean · required

parameters. showClickToSet · boolean · required

If enabled, render a disabled input element with 'Click to set'

parameters. value · string

parameters. help · string

Example:

"Divide axes by this number"

parameters. selectOptions · object[]

Show child attributes

parameters.selectOptions. value · string

What is the string that will be set if this option is selected?

parameters.selectOptions. selected · boolean

parameters.selectOptions. optionLabel · string

What is the label that will be shown to the user for this option?

parameters.selectOptions. priority · number

The following options are optional. See Learn Block Auto Config in Notion. Higher priority will get chosen based on limits below.

parameters.selectOptions. romEstimate · number

Estimated ROM footprint for this choice. Will be tested against ROM budget in Studio.

parameters.selectOptions. needsOps · string[]

ML operator needed by this choice.

parameters.selectOptions. needsFeatures · string[]

Feature needed by this choice. (non op related)

parameters. showIf · object

Show child attributes

parameters.showIf. parameter · string · required

parameters.showIf. operator · enum<string> · required

Available options: eq, neq

parameters.showIf. value · string · required

parameters. invalidText · string

parameters. section · enum<string>

Interface section to render parameter in.

Available options: advanced, augmentation, modelProfiling

parameters. multiline · boolean

Only valid for type "string". Will render a multiline text area.

parameters. hint · string

If set, shows a hint below the input.

parameters. placeholder · string

Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")

parameters. valid · object[]

Valid values for parameter.

parameters. items · object

Recursive definition for items of a parameter with type 'array'.

parameters. properties · object

Recursive definition for a parameter with type 'object'.

error · string

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