Create preview AI Actions job

Create preview AI Actions job

Do a dry-run of an AI Actions job over a subset of data. This will instruct the block to propose changes to data items (via "setSampleProposedChanges") rather than apply the changes directly.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/ai-actions/{actionId}/preview

Path parameters

projectId*integer

Project ID

actionId*integer

AI Action ID

Body

application/json

steps*array of AIActionsConfigStep (object)

sampleIds*array of integer

cacheUnchangedSteps*boolean

If enabled, will load cached results from the previous preview job for unchanged jobs. Disable this if you're developing your own custom AI Labeling job, and want to always re-run all steps.

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/ai-actions/{actionId}/preview', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "steps": [
        {}
      ],
      "sampleIds": [],
      "cacheUnchangedSteps": false
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "id": 12873488112
}