Set bounding boxes

Set the bounding boxes for a sample

POST /api/{projectId}/raw-data/{sampleId}/bounding-boxes

Set bounding boxes

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/bounding-boxes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "boundingBoxes": [
    {
      "label": "<string>",
      "x": 123,
      "y": 123,
      "width": 123,
      "height": 123
    }
  ]
}
'

200

{
  "success": true,
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

sampleId · integer · required

Sample ID

Body

application/json

boundingBoxes · object[] · required

Show child attributes

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

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