Set target constraints

Set target constraints

post

Set target constraints for a project. Use the constraints object to capture hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Body

selectedTargetBasedOnstring · enumoptional

A type explaining how the target was chosen. If updating this manually, use the 'user-configured' type

Options: user-configured, default, default-accepted, recent-project, connected-device

targetDevicesobject[]required

The potential targets for the project, where each entry captures hardware attributes that allow target guidance throughout the Studio workflow. The first target in the list is considered as the selected target for the project.

applicationBudgetsobject[]required

A list of application budgets to be configured based on target device. An application budget enables guidance on performance and resource usage. The first application budget in the list is considered as the selected budget for the project.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/target-constraints' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "selectedTargetBasedOn": "user-configured",
    "targetDevices": [
      {
        "processors": [
          {
            "part": "text",
            "format": "low-end MCU",
            "architecture": "Cortex-M",
            "specificArchitecture": "Cortex-M0+",
            "accelerator": "Arm Cortex-U55",
            "fpu": true,
            "clockRateMhz": {
              "minimum": 1,
              "maximum": 1
            },
            "memory": {
              "ram": {
                "fastBytes": {
                  "minimum": 1,
                  "maximum": 1
                },
                "slowBytes": {
                  "minimum": 1,
                  "maximum": 1
                }
              },
              "rom": {
                "fastBytes": {
                  "minimum": 1,
                  "maximum": 1
                },
                "slowBytes": {
                  "minimum": 1,
                  "maximum": 1
                }
              }
            }
          }
        ],
        "board": "text",
        "name": "text",
        "latencyDevice": "cortex-m4f-80mhz"
      }
    ],
    "applicationBudgets": [
      {
        "latencyPerInferenceMs": {
          "minimum": 1,
          "maximum": 1
        },
        "energyPerInferenceJoules": {
          "minimum": 1,
          "maximum": 1
        },
        "memoryOverhead": {
          "ram": {
            "fastBytes": {
              "minimum": 1,
              "maximum": 1
            },
            "slowBytes": {
              "minimum": 1,
              "maximum": 1
            }
          },
          "rom": {
            "fastBytes": {
              "minimum": 1,
              "maximum": 1
            },
            "slowBytes": {
              "minimum": 1,
              "maximum": 1
            }
          }
        }
      }
    ]
  }'

200

200

{
  "success": true,
  "error": "text"
}

OK