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

transformationBlockId*integer

The ID of an AI Actions transform block ID (public or private)

parameters*object

Parameters for the transformation block. These map back to the parameters in OrganizationTransformationBlock 'parameters' property.

sampleIds*array of integer

Response

Body

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

Response

PreviousCreate synthetic data NextCreate AI Actions job

Last updated 7 days ago

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({
      "sampleIds": []
    }),
});
const data = await response.json();