Images

List images

Browse images from one brand or across your brands.

get/images

Request

  • Base URL
    https://www.rainbrand.com/api/v1
  • URL
    https://www.rainbrand.com/api/v1/images
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://www.rainbrand.com/api/auth/oauth2/authorize
      Token URL: https://www.rainbrand.com/api/auth/oauth2/token

Query parameters

idsstring

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

workspaceIdstring

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

brandSessionIdstring uuid

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

limitinteger

Results per page (1–100, default 50)

cursorstring

Pagination cursor from a previous response's nextCursor

source'generated' | 'uploaded' | 'scraped'

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

status'pending' | 'generating' | 'completed' | 'failed'

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

actionType'generation' | 'edit' | 'resize' | 'variant' | 'recreate' | 'remove-background' | 'vectorize'

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

boolean
OR
'0' | '1' | 'true' | 'false'
boolean
OR
'0' | '1' | 'true' | 'false'
timeoutinteger

Max seconds to wait (default 120, max 295)

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.