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

Possible values:

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v1/api/{projectId}/target-constraints HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 820

{
  "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

OK

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