---
url: /orchestration/reference/operations/InvokeVideoFrameExtractionStepTemplate.md
description: 'POST /v2/consumer/recipes/videoFrameExtraction — Video Frame Extraction'
---

> Documentation index: https://developer.civitai.com/llms.txt — every page on this site has a markdown version at its URL + `.md`.

# Video Frame Extraction

`POST https://orchestration.civitai.com/v2/consumer/recipes/videoFrameExtraction`

Operation `InvokeVideoFrameExtractionStepTemplate` · Recipes · Civitai Orchestration API, generated from the published OpenAPI spec ([v2-consumers.json](https://developer.civitai.com/openapi/v2-consumers.json)); the interactive HTML page is this URL without `.md`.

Extracts unique frames from a video at a specified rate, filtering near-duplicates by perceptual hash.

## Authentication

Send `Authorization: Bearer <token>` (the spec's `ApiKey` scheme); this operation documents `401 Unauthorized` for a missing or invalid token. See [Authentication](https://developer.civitai.com/orchestration/guide/authentication.md).

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `experimental` | query | boolean | no |  |
| `allowMatureContent` | query | boolean | no |  |
| `whatif` | query | boolean | no |  |
| `ephemeral` | query | boolean | no |  |
| `tier` | query | `WorkflowTier` (one of `paid`, `free`) | no | How a workflow is paid for. |

## Request body

Optional. Content types: `application/json`, `text/json`, `application/*+json`.

Schema `VideoFrameExtractionInput`.

| Field | Type | Required | Description |
|---|---|---|---|
| `videoUrl` | string (uri) | yes |  |
| `frameRate` | number (double) | no | Frames per second to extract. (default `1`) |
| `uniqueThreshold` | number (double) | no | Similarity (0.0 to 1.0) above which a frame counts as a duplicate and is dropped. (default `0.9`) |
| `maxFrames` | integer (int32), nullable | no | Maximum number of unique frames to extract; null extracts all. |
| `startTime` | number (double) | no | Seconds into the video to start extracting from. (default `0`) |
| `public` | boolean, nullable | no | Serves the frames at stable unsigned urls. Privileged callers only: nothing gates a read of one, so a block decided after the fact cannot take it back. |

## Responses

### 200 OK

Content type: `application/json`.

Schema `VideoFrameExtractionOutput`.

| Field | Type | Required | Description |
|---|---|---|---|
| `frames` | array of `ImageBlob` | yes |  |
| `totalFramesExtracted` | integer (int32) | yes |  |

### 400 Bad Request

Content type: `application/json`.

Schema `ProblemDetails`.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | string, nullable | no |  |
| `title` | string, nullable | no |  |
| `status` | integer (int32), nullable | no |  |
| `detail` | string, nullable | no |  |
| `instance` | string, nullable | no |  |

### 401 Unauthorized

Content type: `application/json`.

Schema `ProblemDetails` — fields as listed above.

### 403 Forbidden

Content type: `application/json`.

Schema `ProblemDetails` — fields as listed above.