STUDIO API ENDPOINTS
- GETList active projects
- POSTCreate new project
- GETGet development keys
- GETGet downloads
- GETDownload CSV Wizard config
- GETGet CSV Wizard uploaded file info
- POSTStore CSV Wizard uploaded file
- GETDownload CSV Wizard uploaded file
- POSTAdd collaborator
- POSTRemove collaborator
- POSTTransfer ownership (user)
- POSTTransfer ownership (organization)
- GETGet HMAC keys
- POSTAdd HMAC key
- DELRemove HMAC key
- GETGet API keys
- POSTAdd API key
- DELRevoke API key
- GETList emails
- GETGet socket token
- GETGet data axes summary
- GETGet data summary
- GETGet the interval (in ms) of the training data
- POSTSet compute time limit
- POSTSet DSP file size limit
- GETList versions
- GETList public versions
- POSTUpdate version
- DELDelete versions
- POSTMake version private
- POSTUpload image for readme
- POSTLaunch getting started wizard
- GETLast modification
- GETDevelopment boards
- GETGet target constraints
- POSTSet target constraints
- GETGet a list of all model variants available for this project
- POSTDismiss a notification
- GETGet synthetic data config
- GETList AI Actions
- POSTSet AI Actions order
- POSTCreate AI Action
- GETGet new AI Actions config
- GETGet AI Actions config
- POSTSave AI Actions config
- DELDelete AI Actions config
- POSTPreview samples for AI Actions
- GETClear AI Actions proposed changes
- POSTUpdate tags
- GETList public projects
- GETList public project types
- GETProject information
- POSTUpdate project
- DELRemove project
- GETPublic project information
- GET
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/target-constraints \
--header 'x-api-key: <api-key>'{
"success": true,
"error": "<string>",
"targetConstraints": {
"targetDevices": [
{
"processors": [
{
"part": "<string>",
"format": "low-end MCU",
"architecture": "Cortex-M",
"specificArchitecture": "Cortex-M0+",
"accelerator": "Arm Cortex-U55",
"fpu": true,
"clockRateMhz": {
"minimum": 123,
"maximum": 123
},
"memory": {
"ram": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
},
"rom": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
}
}
}
],
"board": "<string>",
"name": "<string>",
"latencyDevice": "cortex-m4f-80mhz"
}
],
"applicationBudgets": [
{
"latencyPerInferenceMs": {
"minimum": 123,
"maximum": 123
},
"energyPerInferenceJoules": {
"minimum": 123,
"maximum": 123
},
"memoryOverhead": {
"ram": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
},
"rom": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
}
}
}
],
"selectedTargetBasedOn": "user-configured"
}
}Get target constraints
Retrieve target constraints for a project. The constraints object captures hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/target-constraints \
--header 'x-api-key: <api-key>'{
"success": true,
"error": "<string>",
"targetConstraints": {
"targetDevices": [
{
"processors": [
{
"part": "<string>",
"format": "low-end MCU",
"architecture": "Cortex-M",
"specificArchitecture": "Cortex-M0+",
"accelerator": "Arm Cortex-U55",
"fpu": true,
"clockRateMhz": {
"minimum": 123,
"maximum": 123
},
"memory": {
"ram": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
},
"rom": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
}
}
}
],
"board": "<string>",
"name": "<string>",
"latencyDevice": "cortex-m4f-80mhz"
}
],
"applicationBudgets": [
{
"latencyPerInferenceMs": {
"minimum": 123,
"maximum": 123
},
"energyPerInferenceJoules": {
"minimum": 123,
"maximum": 123
},
"memoryOverhead": {
"ram": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
},
"rom": {
"fastBytes": {
"minimum": 123,
"maximum": 123
},
"slowBytes": {
"minimum": 123,
"maximum": 123
}
}
}
}
],
"selectedTargetBasedOn": "user-configured"
}
}Authorizations
Path Parameters
Project ID
Response
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Target processors
Show child attributes
Show child attributes
The exact part number, if available
Processor type, serving as a broad descriptor for the intended use-case
"low-end MCU"
Processor family, informing about the processor's instruction set and core design
"Cortex-M"
Processor architecture, informing about the specific processor, if known
"Cortex-M0+"
Target accelerator, if any
"Arm Cortex-U55"
Does the target processor have a floating point unit
RAM and ROM specifications of target
Show child attributes
Show child attributes
Describes performance characteristics of a particular memory type
Show child attributes
Show child attributes
Describes performance characteristics of a particular memory type
Show child attributes
Show child attributes
The exact dev board part number, if available
Display name in Studio
MCU identifier, if available
"cortex-m4f-80mhz"
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.
Show child attributes
Show child attributes
RAM and ROM specifications of target
Show child attributes
Show child attributes
Describes performance characteristics of a particular memory type
Show child attributes
Show child attributes
Describes performance characteristics of a particular memory type
Show child attributes
Show child attributes
A type explaining how the target was chosen. If updating this manually, use the 'user-configured' type
user-configured, default, default-accepted, recent-project, connected-device Was this page helpful?