Skip to main content
POST
/
images
/
search
Semantic Search
curl --request POST \
  --url https://www.trybloom.ai/api/v1/images/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "brandSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "limit": 10,
  "cursor": "<string>",
  "maxDistance": 0.7
}
'
{
  "data": {
    "query": "<string>",
    "candidates": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "description": "<string>",
        "width": 123,
        "height": 123,
        "distance": 123
      }
    ],
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.trybloom.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
brandSessionId
string<uuid>
required

Brand session UUID to search within

​
query
string
required

Visual concept to search for. Plain noun phrases work best — e.g., 'drone in flight', 'team working at desks', 'product on white background'.

Required string length: 1 - 500
​
limit
integer
default:10

Max results to return (default 10, max 50)

Required range: 1 <= x <= 50
​
cursor
string

Pagination cursor from a previous response's nextCursor

​
maxDistance
number
default:0.7

Cosine-distance cutoff (smaller = stricter). Default 0.7 gives good relevance for most queries; loosen for long-tail matches, tighten for stricter recall. Distances above this threshold are dropped.

Required range: 0 <= x <= 2

Response

OK

​
data
object
required