Skip to main content
GET
List images

Authorizations

x-api-key
string
header
required

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

Query Parameters

ids
string

Comma-separated image IDs to filter by (max 50). Selected-model generation IDs are not supported.

workspaceId
string

Team workspace ID. Scopes results to that workspace. Omit to list across every workspace the caller can see.

Minimum string length: 1
brandSessionId
string<uuid>

Brand ID (from GET /brands). Omit to list images across all brands.

limit
integer
default:50

Results per page (1–100, default 50)

Required range: 1 <= x <= 100
cursor
string

Pagination cursor from a previous response's nextCursor

source
enum<string>

Filter by image source. "generated" = AI-created, "uploaded" = user uploads, "scraped" = website images from brand onboarding

Available options:
generated,
uploaded,
scraped
status
enum<string>

Filter by generation status (only applies to generated images — uploaded/scraped images are excluded when this filter is active)

Available options:
pending,
generating,
completed,
failed
actionType
enum<string>

Filter by action type (only applies to generated images — uploaded/scraped images are excluded when this filter is active)

Available options:
generation,
edit,
resize,
variant,
recreate,
remove-background,
vectorize
includeUrls

Include signed download URLs for completed images

wait
default:false

Hold the connection until every image in ids reaches a terminal status. Selected-model generation IDs are not supported. No-op when ids is omitted.

timeout
integer
default:120

Max seconds to wait (default 120, max 295)

Required range: 1 <= x <= 295

Response

OK

data
object
required