Sign in

v1

latestOpenAPI 3.0.02026-07-13650400.5 KB
AI Search

Search by Image

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 at support@bria.ai.

get/search_similar_images

Query parameters

vhashstring
Example:e01592ef1188df76

the visual id of the image for which the user is looking for similar images.

num_results_per_pageinteger
Example:1

how many images you would like to receive in the current call. The default value is 50. The maximum value is 500.

pageinteger
Example:1

which batch of images you would like to receive in the current call. The default value is 1. For each query, we support 800 results, so if you set num_results_per_page=50, you will have 16 pages of results.

gallery_idstring
Example:425

Bria will provide you with this parameter which represents your account's image gallery. You must include this parameter.

urlstring
Example:If you are using the vhash paramater, there is no need to use this parameter

URL of an image, for which you would like to find similar images. When you want to search based on modified images, or images that have not been uploaded or registered to Bria, you can use this parameter. When this parameter is provided, the visual_id parameter can be None. The supported file types are jpg, jpeg and png, up to 12 mb.

Headers

api_tokenstring required

Response

Successful operation.

Example response

{
  "results": [
    {
      "visual_id": "a169a6862f24de75",
      "org_image_key": "None",
      "source_url": "None"
    }
  ]
}