Propose changes

Propose changes

post

Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerRequired

Project ID

sampleIdintegerRequired

Sample ID

Body

jobIdintegerRequired

Job ID of an AI Actions job. This is passed into your job via the --propose-actions argument.

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v1/api/{projectId}/raw-data/{sampleId}/propose-changes HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "jobId": 1,
  "proposedChanges": {
    "label": "text",
    "isDisabled": true,
    "boundingBoxes": [
      {
        "label": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1
      }
    ],
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "structuredLabels": [
      {
        "startIndex": 1,
        "endIndex": 1,
        "label": "text"
      }
    ]
  }
}

200

OK

{
  "success": true,
  "error": "text"
}