Skip to main content
POST
/
api
/
{projectId}
/
jobs
/
ai-actions
/
{actionId}
/
preview
Create preview AI Actions job
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/ai-actions/{actionId}/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "steps": [
    {
      "transformationBlockId": 123,
      "parameters": {}
    }
  ],
  "sampleIds": [
    123
  ],
  "cacheUnchangedSteps": true
}
'
{
  "success": true,
  "id": 12873488112,
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

​
actionId
integer
required

AI Action ID

Body

application/json
​
steps
object[]
required
​
sampleIds
integer[]
required
​
cacheUnchangedSteps
boolean
required

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 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
id
integer
required

Job identifier. Status updates will include this identifier.

Example:

12873488112

​
error
string

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