---
title: "Get Cluster Images"
method: GET
path: "/face-clusters/{cluster_id}/images"
tags: ["Face Clusters"]
---

# Get Cluster Images

`GET /face-clusters/{cluster_id}/images`

## Request

- Base URL: `http://localhost:52123`
- URL: `http://localhost:52123/face-clusters/{cluster_id}/images`
- Auth: none declared
- TypeScript: <https://skmtc.dev/aossie-org/apis/pictopy/docs/face-clusters/:cluster_id/images/get.ts> (a function with typed inputs; its response is checked against the schema)

Get all images that contain faces belonging to a specific cluster.

## Path parameters

- `cluster_id` string, required

## Response `200`

Successful Response

- GetClusterImagesResponse: Response model for getting images in a cluster.
  - `success` boolean, required
  - `message` string, nullable
  - `error` string, nullable
  - `data` GetClusterImagesData: Data model for cluster images response.
    - `cluster_id` string, required
    - `cluster_name` string, nullable
    - `images` ImageInCluster[], required
      - `id` string, required
      - `path` string, required
      - `thumbnailPath` string, nullable
      - `metadata` object, nullable
      - `face_id` integer, required
      - `confidence` number, nullable
      - `bbox` object, nullable
    - `total_images` integer, required
    - `videos` VideoData[]
      - `id` string, required
      - `path` string, required
      - `folder_id` string, required
      - `thumbnailPath` string, nullable, required
      - `metadata` VideoMetadataModel, required
        - `name` string, required
        - `date_created` string, nullable, required
        - `width` integer, required
        - `height` integer, required
        - `duration` number, nullable
        - `fps` number, nullable
        - `file_location` string, required
        - `file_size` integer, required
        - `item_type` string, required
      - `isFavourite` boolean, required
      - `favouritedAt` string, nullable
      - `tags` string[], nullable
    - `total_videos` integer

## Other responses

- `404`: Not Found
- `422`: Validation Error
- `500`: Internal Server Error

## Changes

- **2026-09-21** `f7f084c3344d`: 2 info
  - added the optional property `data/anyOf[subschema #1: GetClusterImagesData]/total_videos` to the response with the `200` status
  - added the optional property `data/anyOf[subschema #1: GetClusterImagesData]/videos` to the response with the `200` status
- **2025-10-08** `b105a438e6dd`: 2 breaking
  - response property `data/anyOf[subschema #1: GetClusterImagesData]/images/items/metadata` list-of-types was widened by adding types `object` to media type `application/json` of response `200`
  - the `data/anyOf[subschema #1: GetClusterImagesData]/images/items/metadata/anyOf[subschema #1]/` response's property type changed from `string` to `object` for status `200`
- **2025-08-26** `2e78324b9970`: 1 info
  - endpoint added
- **2025-08-05** `14c08755eaeb`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/aossie-org/apis/pictopy/changes/face-clusters/:cluster_id/images/get.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)