---
title: "Search by Image"
method: GET
path: "/search_similar_images"
tags: ["Endpoints"]
---

# Search by Image

`GET /search_similar_images`

**Description**

By using the *Search Route*, you can utilize Bria's generative search capabilities, which don't require labels or keywords. The user can send any text query and receive relevant images that match the query.

The *Search Route* returns the images, sorted by the match score, from highest match to lowest match. The images are returned in batches, and you can specify how many images to receive in one batch, and which batch to receive in each call.

Search will only work on images that have been onboarded using the `register` endpoint.

**Note:** To use this endpoint, please [Contact Us](https://bria.ai/contact-us).

## Query parameters

- `vhash` string
- `num_results_per_page` integer
- `page` integer
- `gallery_id` string
- `url` string

## Headers

- `api_token` string, required

## Response `200`

Successful operation.

- object
  - `results` object[] — there are multiple objects in this array (based on the amount specified in num_results_per_page) and each object represents a single image. The images in the array are sorted by the similarity score, from the highest to the lowest. If the specified batch (=page) is empty, the results array will be empty.
    - `visual_id` string — visual id of the image, documented in Bria.
    - `org_image_key` string — It will be returned if the image was registered using an org_image_key.
    - `source_url` string — It will be returned if the image was registered using a URL.

## Other responses

- `400` — Bad request.
- `404` — Specified Image does not exist.
- `405` — Method not allowed.
- `429` — Request limit exceeded. Your account has reached its maximum allowed requests. Please upgrade your plan or try again later.
- `500` — Internal server error.
- `506` — Insufficient data. The given input is not supported by the Bria API.

---

[API](https://skmtc.net/bria-ai/apis/overview.md) · [All operations](https://skmtc.net/bria-ai/apis/overview/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bria-ai/overview/revisions/992a9210e0cf/schema)