---
title: "GET /images/model-matches"
method: GET
path: "/images/model-matches"
tags: ["Image Search"]
---

# GET /images/model-matches

`GET /images/model-matches`

We are continually improving image recognition capabilities. At current state, the following properties are advisable for good performance:
- Images with the object by itself.
- Images with a plain background.
- The color of the object usually does not affect detection outcomes.

**Examples of Images that Perform Well**

![Images that perform well](assets/good_images.png)
- plain background
- object isolated on its own

**Examples of Images to Avoid**

![Images to avoid](assets/bad_images.png)
- multiple objects
- cluttered or busy background

## Query parameters

- `id` string[], required
- `search` string
- `filter` string — A string in the form `<FilterProperty>(<FilterOperator>(<FilterValue>))[,FilterExpressions]`. See the [API Reference](https://physna.github.io/public-api-guide/api-reference/filter-expressions) for more details. Example: ``` id(between(1,1000)),createdAt(not(lt('2022-01-01T00:00:00.000Z'))) ```
- `page` integer
- `perPage` integer

## Headers

- `X-PHYSNA-TENANTID` string

## Response `200`

Ok

- GetImageMatchesResponse
  - `matches` ImageMatch[], required
    - `matchedModel` ModelWithMetadata, required
      - `createdAt` string, required
      - `deletedAt` string
      - `fileName` string, required
      - `fileType` string, required
      - `folderId` number, double, required
      - `id` string, required
      - `isAssembly` boolean, required
      - `name` string, required
      - `ownerId` string, required
      - `state` string, required
      - `thumbnail` string
      - `units` string, required
      - `collections` PickCollectionIdOrName[]
        - `id` string, required
        - `name` string
      - `labels` Label[]
        - `displayName` string, required
        - `source` string, required
        - `createdAt` string, date-time, required
        - `rejected` boolean
      - `geometry` ModelGeometry — Model geometry of ingested model, including the model's bounding box lengths, it's surface area, and volume.
        - `obbMinLength` number, double, required
        - `obbMidLength` number, double, required
        - `obbMaxLength` number, double, required
        - `surfaceArea` number, double, required
        - `modelVolume` number, double, required
      - `metadata` Metadata[], required
        - `modelId` string, required
        - `metadataKeyId` number, double, required
        - `name` string, nullable, required
        - `value` string, required
  - `pageData` PageData, required
    - `total` integer, required
    - `perPage` integer, required
    - `currentPage` integer, required
    - `lastPage` integer, required
    - `startIndex` integer, required
    - `endIndex` integer, required
  - `filterData` MatchFilterData, required
    - `folders` PickFolderIdOrName[], required
      - `id` number, double, required
      - `name` string, required
    - `metadata` MetadataFilterData[], required
      - `metadataKeyId` number, double, required
      - `name` string, required
      - `values` string[], required
    - `createdAt` string[], required
    - `isAssembly` boolean[], required
    - `fileType` string[], required
    - `units` string[], required
    - `collections` CollectionFilterData, required
      - `names` string[], required
      - `tags` string[], required
      - `metadata` MetadataFilterData[], required
        - `metadataKeyId` number, double, required
        - `name` string, required
        - `values` string[], required
  - `image` SignedImage, required
    - `filename` string, required
    - `url` string, required
  - `images` SignedImage[], required
    - `filename` string, required
    - `url` string, required

## Other responses

- `400`
- `404`

---

[API](https://skmtc.dev/physna/apis/physna-public-api.md) · [All operations](https://skmtc.dev/physna/apis/physna-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/physna/physna-public-api/revisions/18b6af4c004d/schema)