---
title: "Semantic Search Images"
method: GET
path: "/images/semantic-search"
tags: ["Images"]
---

# Semantic Search Images

`GET /images/semantic-search`

## Request

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

Semantic search images by query text using SigLIP2.

## Query parameters

- `query` string, required: Query text to search for

## Response `200`

Successful Response

- AppRoutesImagesSemanticSearchResponse
  - `success` boolean, required
  - `message` string, required
  - `data` AppRoutesImagesSemanticSearchData, required
    - `images` SemanticSearchImage[], required
      - `id` string, required
      - `path` string, required
      - `folder_id` string, required
      - `thumbnailPath` string, required
      - `metadata` MetadataModel, required
        - `name` string, required
        - `date_created` string, nullable, required
        - `width` integer, required
        - `height` integer, required
        - `file_location` string, required
        - `file_size` integer, required
        - `item_type` string, required
        - `latitude` number, nullable
        - `longitude` number, nullable
        - `location` string, nullable
      - `isTagged` boolean, required
      - `isFavourite` boolean, required
      - `favouritedAt` string, nullable
      - `tags` string[], nullable
      - `score` number, required
    - `total` integer, required

## Other responses

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

## Changes

- **2026-09-16** `72c3038bc111`: 1 info
  - added the optional property `data/images/items/favouritedAt` to the response with the `200` status
- **2026-07-16** `44da060e6548`: 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/images/semantic-search/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)
