Skip to main content
GET
Get brand images

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Query Parameters

q
string

Semantic search over what the images show. Costs 1 credit per new search; results come back in relevance order and sort is ignored. Logos are not searchable.

Required string length: 1 - 500
kind
enum<string>

logo, brand (images from the site or uploaded, including the social preview and site screenshot) or generated (made with Brew). Omit for every kind.

Available options:
logo,
brand,
generated
sort
enum<string>

Browse order: newest (default) or oldest.

Available options:
newest,
oldest
limit
integer

Page size (1-100). Defaults to 100.

Required range: 1 <= x <= 100
Example:

50

cursor
string
Required string length: 1 - 512

Response

A page of brand assets (semantic results, in relevance order, when ?q=).

data
object[]
required
pagination
object
required