Classify sample with post-processing

Classify a sample using post-processing parameters. Sample should be in the post-processing dataset.

POST /api/{projectId}/post-processing/{postProcessingId}/samples/{sampleId}/classify

Try it

Classify sample with post-processing

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/post-processing/{postProcessingId}/samples/{sampleId}/classify \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "config": {
    "enabled": true,
    "parameters": {}
  },
  "variant": "int8"
}
'

200

{
  "success": true,
  "results": {
    "objectTracking": {
      "frames": [
        {
          "frameIndex": 123,
          "objects": [
            {
              "label": "<string>",
              "id": 123,
              "x": 123,
              "y": 123,
              "width": 123,
              "height": 123
            }
          ]
        }
      ],
      "parameters": {}
    },
    "objectDetection": {
      "frames": [
        {
          "frameIndex": 123,
          "objects": [
            {
              "label": "<string>",
              "x": 123,
              "y": 123,
              "width": 123,
              "height": 123,
              "score": 123
            }
          ]
        }
      ]
    }
  },
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

postProcessingId · integer · required

Post-processing Block ID, use the impulse functions to retrieve the ID

sampleId · integer · required

Sample ID

Body

application/json

config · object · required

Show child attributes

config. enabled · boolean · required

config. parameters · object · required

Show child attributes

config.parameters. {key} · string

variant · enum<string> · required

Available options: int8, float32, akida

Response

200 - application/json

OK

Option 1

success · boolean · required

Whether the operation succeeded

results · object · required

Show child attributes

results. objectTracking · object

Show child attributes

results.objectTracking. frames · object[] · required

Show child attributes

results.objectTracking.frames. frameIndex · integer · required

results.objectTracking.frames. objects · object[] · required

Show child attributes

results.objectTracking.frames.objects. label · string · required

results.objectTracking.frames.objects. id · integer · required

results.objectTracking.frames.objects. x · number · required

results.objectTracking.frames.objects. y · number · required

results.objectTracking.frames.objects. width · number · required

results.objectTracking.frames.objects. height · number · required

results.objectTracking. parameters · object · required

Show child attributes

results.objectTracking.parameters. {key} · string

results. objectDetection · object

Show child attributes

results.objectDetection. frames · object[] · required

Show child attributes

results.objectDetection.frames. frameIndex · integer · required

results.objectDetection.frames. objects · object[] · required

Show child attributes

results.objectDetection.frames.objects. label · string · required

results.objectDetection.frames.objects. x · number · required

results.objectDetection.frames.objects. y · number · required

results.objectDetection.frames.objects. width · number · required

results.objectDetection.frames.objects. height · number · required

results.objectDetection.frames.objects. score · number · required

error · string

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