BRbrandbooster
avatarsLib
avatarsLib

Search Avatars Route

get/api/v1/avatars-lib/search

Request

  • Base URL
    https://api.brandbooster.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.brandbooster.ai/api/v1/avatars-lib/search
  • Auth
    HTTP bearer

Query parameters

genderstring[] nullable

e.g. Male, Female (multi-value)

age_rangeAgeRangeBand[] nullable

18-24 / 25-34 / 35-44 / 45-54 / 55+ (multi-value; personas span ranges)

age_mininteger nullable

Tighter targeting than age_range

age_maxinteger nullable

Tighter targeting than age_range

ethnicitystring[] nullable

e.g. SouthAsian, Mixed (multi-value)

vibe_expressionstring[] nullable

Soft signal, multi-value

settingstring nullable

Soft signal, e.g. 'home interior', 'studio backdrop'

apparent_class_contextstring nullable

Soft signal

wardrobestring nullable

Soft signal, freetext contains

tagsstring[] nullable

Matches any (multi-value)

shot_typestring[] nullable

headshot / waist-up / full body (multi-value)

anglestring[] nullable

front / three-quarter / profile (multi-value)

orientationstring[] nullable

portrait / landscape (multi-value)

resolution_band'low' | 'medium' | 'high' | 'ultra'

Ordinal quality tiers for AvatarsLib.resolution_band, low-to-high.

ASSUMPTION: the model stores resolution_band as freeform text (whatever the generation pipeline writes), so this ordering is a guess at the real vocabulary. If the pipeline actually emits different band labels (e.g. sd/hd/2k/4k), update this single list -- everything else (the "min acceptable" filter) derives from its order, not its names.

Minimum acceptable band

qstring nullable

Free-text persona description, searched across vibe_expression/wardrobe/setting/tags/review_notes

include_unusableboolean

Include rows with usable_as_reference=false

include_inactiveboolean

Include rows with active=false

limitinteger

People per page (added for a bounded response; not in the original spec)

offsetinteger

Response

Successful Response

unknown required

Changes

No operation changes recorded.