---
title: "Create preview AI Actions job"
method: POST
path: "/api/{projectId}/jobs/ai-actions/{actionId}/preview"
tags: ["Jobs"]
---

# Create preview AI Actions job

`POST /api/{projectId}/jobs/ai-actions/{actionId}/preview`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/ai-actions/{actionId}/preview`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - 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)

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.

## Path parameters

- `projectId` integer, required
- `actionId` integer, required

## Request body

- CreatePreviewAIActionsJobRequest
  - `steps` AIActionsConfigStep[], required
    - `transformationBlockId` integer, required: The selected transformation block ID.
    - `parameters` object, required: Parameters for the transformation block. These map back to the parameters in OrganizationTransformationBlock 'parameters' property.
  - `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`

OK

- StartJobResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `id` integer, required: Job identifier. Status updates will include this identifier.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)