Sign in

v1

latestOpenAPI 3.0.02026-07-13650400.5 KB
AI Search

Search by text

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

Query parameters

querystring
Example:woman traveling in the world

the text query for which the user is looking for matching images.

num_results_per_pageinteger
Example:1

how many images you would like to receive from the gallery search. The default value is 50. The maximum value is 500. No need to use this parameter when gallery_search=false.

pageinteger
Example:1

which batch of images you would like to receive in the current call. Synthetic results will only be included in page no. 1. 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.

style'stock photography' | 'photo realistic' | 'fashion' | 'retro' | 'sports' | 'still life' | 'hyper realistic' | 'travel' | 'artistic' | '3d render' | 'realistic' | 'fantasy' | 'comic book' | 'minimalistic'
Example:photo realistic

Which style you would like to see in your results, this parameter is optional.

atmosphere'dramatic' | 'vivid' | 'warm' | 'cool'
Example:dramatic

Which atmosphere you would like to get in your results, this parameter is optional.

camera'portrait' | 'close up' | 'aerial' | 'landscape'
Example:portrait

Which camera angle you would like to see in your results, this parameter is optional.

medium'photography' | 'art'
Example:photography

Which medium should be included in your results, this parameter is optional.

Headers

api_tokenstring required

Response

Successful operation.

Example response

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