Jobs

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.

post/api/{projectId}/jobs/ai-actions/{actionId}/preview

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/jobs/ai-actions/:actionId/preview/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

actionIdinteger required

AI Action ID

Request body

sampleIdsinteger[] required

cacheUnchangedStepsboolean 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

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Job identifier. Status updates will include this identifier.

Example response

{
  "id": 12873488112
}

Changes

No recorded changes to this operation across all 1 revision of this API.