SearchFilter

Endpoints · All schemas

Field	Required	Description
albumIds	No	See definition below
checksum	No	See definition below
city	No	See definition below
country	No	See definition below
createdAt	No	See definition below
description	No	See definition below
encodedVideoPath	No	See definition below
fileSizeInBytes	No	See definition below
hasAlbums	No	See definition below
hasPeople	No	See definition below
hasTags	No	See definition below
id	No	See definition below
isEncoded	No	See definition below
isFavorite	No	See definition below
isMotion	No	See definition below
isOffline	No	See definition below
lensModel	No	See definition below
libraryId	No	See definition below
localDateTime	No	See definition below
make	No	See definition below
model	No	See definition below
ocr	No	See definition below
or	No	array
originalFileName	No	See definition below
originalPath	No	See definition below
personIds	No	See definition below
petIds	No	See definition below
rating	No	See definition below
state	No	See definition below
tagIds	No	See definition below
takenAt	No	See definition below
trashedAt	No	See definition below
type	No	See definition below
updatedAt	No	See definition below
visibility	No	See definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: IdsFilter, StringFilter, StringFilterNullable, DateFilter, StringPatternFilter, NumberFilter, BoolFilter, IdFilter, IdFilterNullable, StringSimilarityFilter, SearchFilterBranch, NumberFilterNullable, DateFilterNullable, EnumFilterAssetType, EnumFilterAssetVisibility

{
  "additionalProperties": false,
  "properties": {
    "albumIds": {
      "$ref": "#/components/schemas/IdsFilter"
    },
    "checksum": {
      "$ref": "#/components/schemas/StringFilter"
    },
    "city": {
      "$ref": "#/components/schemas/StringFilterNullable"
    },
    "country": {
      "$ref": "#/components/schemas/StringFilterNullable"
    },
    "createdAt": {
      "$ref": "#/components/schemas/DateFilter"
    },
    "description": {
      "$ref": "#/components/schemas/StringPatternFilter"
    },
    "encodedVideoPath": {
      "$ref": "#/components/schemas/StringFilter"
    },
    "fileSizeInBytes": {
      "$ref": "#/components/schemas/NumberFilter"
    },
    "hasAlbums": {
      "$ref": "#/components/schemas/BoolFilter"
    },
    "hasPeople": {
      "$ref": "#/components/schemas/BoolFilter"
    },
    "hasTags": {
      "$ref": "#/components/schemas/BoolFilter"
    },
    "id": {
      "$ref": "#/components/schemas/IdFilter"
    },
    "isEncoded": {
      "$ref": "#/components/schemas/BoolFilter"
    },
    "isFavorite": {
      "$ref": "#/components/schemas/BoolFilter"
    },
    "isMotion": {
      "$ref": "#/components/schemas/BoolFilter"
    },
    "isOffline": {
      "$ref": "#/components/schemas/BoolFilter"
    },
    "lensModel": {
      "$ref": "#/components/schemas/StringPatternFilter"
    },
    "libraryId": {
      "$ref": "#/components/schemas/IdFilterNullable"
    },
    "localDateTime": {
      "$ref": "#/components/schemas/DateFilter"
    },
    "make": {
      "$ref": "#/components/schemas/StringPatternFilter"
    },
    "model": {
      "$ref": "#/components/schemas/StringPatternFilter"
    },
    "ocr": {
      "$ref": "#/components/schemas/StringSimilarityFilter"
    },
    "or": {
      "items": {
        "$ref": "#/components/schemas/SearchFilterBranch"
      },
      "minItems": 1,
      "type": "array"
    },
    "originalFileName": {
      "$ref": "#/components/schemas/StringPatternFilter"
    },
    "originalPath": {
      "$ref": "#/components/schemas/StringPatternFilter"
    },
    "personIds": {
      "$ref": "#/components/schemas/IdsFilter"
    },
    "petIds": {
      "$ref": "#/components/schemas/IdsFilter"
    },
    "rating": {
      "$ref": "#/components/schemas/NumberFilterNullable"
    },
    "state": {
      "$ref": "#/components/schemas/StringFilterNullable"
    },
    "tagIds": {
      "$ref": "#/components/schemas/IdsFilter"
    },
    "takenAt": {
      "$ref": "#/components/schemas/DateFilter"
    },
    "trashedAt": {
      "$ref": "#/components/schemas/DateFilterNullable"
    },
    "type": {
      "$ref": "#/components/schemas/EnumFilterAssetType"
    },
    "updatedAt": {
      "$ref": "#/components/schemas/DateFilter"
    },
    "visibility": {
      "$ref": "#/components/schemas/EnumFilterAssetVisibility"
    }
  },
  "type": "object"
}