Update structured labels

Set structured labels for a sample. If a sample has structured labels the label column is ignored, and the sample is allowed to have multiple labels. An array of needs to be passed in with labels for the complete sample (see valuesCount to get the upper bound). endIndex is inclusive. If you pass in an incorrect array (e.g. missing values) you’ll get an error back.

POST /api/{projectId}/raw-data/{sampleId}/structured-labels

Update structured labels

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/structured-labels \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "structuredLabels": [
    {
      "startIndex": 123,
      "endIndex": 123,
      "label": "<string>"
    }
  ]
}
'

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

structuredLabels · 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)