Check post-processing results for sample

Check post-processing results for sample

post

Retrieve post-processing results for a specific sample, e.g. whether it has generated features already.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

projectIdintegerRequired

Project ID

postProcessingIdintegerRequired

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

sampleIdintegerRequired

Sample ID

Body

enabledbooleanRequired

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/{projectId}/post-processing/{postProcessingId}/samples/{sampleId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "enabled": true,
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

{
  "success": true,
  "error": "text",
  "hasResults": "has-results",
  "results": {
    "objectTracking": {
      "frames": [
        {
          "frameIndex": 1,
          "objects": [
            {
              "label": "text",
              "id": 1,
              "x": 1,
              "y": 1,
              "width": 1,
              "height": 1
            }
          ]
        }
      ],
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "objectDetection": {
      "frames": [
        {
          "frameIndex": 1,
          "objects": [
            {
              "label": "text",
              "x": 1,
              "y": 1,
              "width": 1,
              "height": 1,
              "score": 1
            }
          ]
        }
      ]
    }
  },
  "jobIsRunning": {
    "jobId": 1,
    "config": {
      "enabled": true,
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  }
}