STUDIO API ENDPOINTS
- GETList samples
- GETCount samples
- GETObject detection label queue
- GETObject detection label queue count
- POSTRebalance dataset
- POSTRebalance dataset
- GETGet dataset ratio
- POSTClear all object detection labels
- POSTRemove all samples
- POSTRemove all samples by category
- GETGet project sample metadata
- GETGet project sample metadata filter options
- GETList data with "imported from" metadata key
- GETGet sample
- DELRemove sample
- GETDownload file
- GETGet WAV file
- GETGet image file
- GETGet video file
- GETGet sample slice
- POSTRename sample
- POSTEdit label
- POSTMove sample
- POSTCrop sample
- POSTSplit sample into frames
- POSTFind segments
- POSTSegment sample
- POSTSet bounding boxes
- POSTUpdate structured labels
- POSTStore the last segment length
- GETGet the original downsampled data
- POSTRetry processing
- POSTEnable sample
- POSTDisable sample
- POSTAuto-label an image
- POSTSet sample metadata
- POSTMove sample to labeling queue
- POSTPropose changes
- POSTSet sample video dimensions
- POSTEdit labels for multiple samples
- POSTEdit bounding boxes for multiple samples
- POSTRemove multiple samples
- POSTMove multiple samples
- POSTEnable multiple samples
- POSTDisable multiple samples
- POSTAdd metadata (multiple samples)
- POSTClear metadata by key (multiple samples)
- POSTClear all metadata (multiple samples)
- POSTTrack objects
- GETGet data explorer features
- GETCheck data explorer features
- GETGet data explorer predictions
- POSTClear data explorer
- GETGet data explorer settings
- POSTSet data explorer settings
- GETCheck if data diversity metrics exist
- GETGet diversity metrics data
- GETCheck if label noise metrics exist
- GETGet label noise data
- GETGet AI Actions proposed changes
- GET
Propose changes
Copy
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"jobId": 123,
"proposedChanges": {
"label": "<string>",
"isDisabled": true,
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123
}
],
"metadata": {},
"structuredLabels": [
{
"startIndex": 123,
"endIndex": 123,
"label": "<string>"
}
]
}
}
'Copy
{
"success": true,
"error": "<string>"
}Propose changes
Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.
POST
/
api
/
{projectId}
/
raw-data
/
{sampleId}
/
propose-changes
Propose changes
Copy
curl --request POST \
--url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"jobId": 123,
"proposedChanges": {
"label": "<string>",
"isDisabled": true,
"boundingBoxes": [
{
"label": "<string>",
"x": 123,
"y": 123,
"width": 123,
"height": 123
}
],
"metadata": {},
"structuredLabels": [
{
"startIndex": 123,
"endIndex": 123,
"label": "<string>"
}
]
}
}
'Copy
{
"success": true,
"error": "<string>"
}Authorizations
Body
application/json
Job ID of an AI Actions job. This is passed into your job via the --propose-actions argument.
Show child attributes
Show child attributes
New label (single-label)
True if the current sample should be disabled; or false if it should not be disabled.
List of bounding boxes. The existing bounding boxes on the sample will be replaced (so if you want to add new bounding boxes, use the existing list as a basis).
New label (multi-label)
Show child attributes
Show child attributes
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
Was this page helpful?
⌘I