---
title: "Scan Video Faces"
method: POST
path: "/videos/scan-faces"
tags: ["Videos"]
---

# Scan Video Faces

`POST /videos/scan-faces`

## Request

- Base URL: `http://localhost:52123`
- URL: `http://localhost:52123/videos/scan-faces`
- Auth: none declared
- TypeScript: <https://skmtc.dev/aossie-org/apis/pictopy/docs/videos/scan-faces/post.ts> (a function with typed inputs; its response is checked against the schema)

Start a background pass over videos tagged before finding people in
videos was turned on. Returns how many it has to get through.

## Response `200`

Successful Response

- FaceScanStatusResponse
  - `success` boolean, required
  - `message` string, required
  - `data` FaceScanStatusData, required
    - `total` integer, required
    - `scanned` integer, required
    - `pending` integer, required
    - `running` boolean
    - `failed` boolean

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

## Changes

- **2026-09-21** `26c6f32c2299`: 2 info
  - added the optional property `data/failed` to the response with the `200` status
  - added the optional property `data/running` to the response with the `200` status
- **2026-09-21** `f7f084c3344d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/aossie-org/apis/pictopy/changes/videos/scan-faces/post.md)

---

[API](https://skmtc.dev/aossie-org/apis/pictopy.md) - [All operations](https://skmtc.dev/aossie-org/apis/pictopy/llms.txt) - [OpenAPI document](https://skmtc.dev/aossie-org/apis/pictopy/revisions/9fe895216588?raw)