Create preview AI Actions job

Create preview AI Actions job

post

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

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

actionIdintegerrequired

AI Action ID

Body

stepsobject[]required

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/ai-actions/{actionId}/preview' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "steps": [
      {
        "transformationBlockId": 1,
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "sampleIds": [
      1
    ],
    "cacheUnchangedSteps": true
  }'

200

200

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

OK