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.
Authorizations
Path parameters
projectIdintegerRequired
Project ID
actionIdintegerRequired
AI Action ID
Body
sampleIdsinteger[]Required
cacheUnchangedStepsbooleanRequired
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.
Responses
200
OK
application/json
Responseall of
post
POST /v1/api/{projectId}/jobs/ai-actions/{actionId}/preview HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 130
{
"steps": [
{
"transformationBlockId": 1,
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
],
"sampleIds": [
1
],
"cacheUnchangedSteps": true
}
200
OK
{
"success": true,
"error": "text",
"id": 12873488112
}
Last updated
Was this helpful?