Skip to main content
POST
/
api
/
{projectId}
/
raw-data
/
{sampleId}
/
autolabel
Auto-label an image
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/autolabel \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "success": true,
  "results": [
    {
      "label": "<string>",
      "x": 123,
      "y": 123,
      "width": 123,
      "height": 123
    }
  ],
  "allLabels": [
    "<string>"
  ],
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

​
sampleId
integer
required

Sample ID

Body

application/json
​
neuralNetwork
enum<string>
required
Available options:
yolov5,
yolo-pro,
currentProject

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
results
object[]
required
​
allLabels
string[]
required
​
error
string

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