Propose changes

Propose changes

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

post

/api/{projectId}/raw-data/{sampleId}/propose-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.

proposedChangesobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/{sampleId}/propose-changes' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"jobId":1,"proposedChanges":{"boundingBoxes":[{"label":"text","x":1,"y":1,"width":1,"height":1}],"metadata":{},"structuredLabels":[{"startIndex":1,"endIndex":1,"label":"text"}]}}'

200

200

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

OK