Skip to main content
POST
Semantic search

Authorizations

x-api-key
string
header
required

Bloom API key, for example x-api-key: bloom_sk_....

Body

application/json
brandSessionId
string<uuid>
required

Brand ID 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). The default of 0.7 works well for most queries. Use a higher value for broader matching or a lower value for stricter results. Distances above this threshold are excluded.

Required range: 0 <= x <= 2

Response

OK

data
object
required