Skip to main content
GET
/
images
List images
curl --request GET \
  --url https://www.trybloom.ai/api/v1/images \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "images": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prompt": "<string>",
        "description": "<string>",
        "width": 123,
        "height": 123,
        "variantGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "workspaceId": "<string>",
        "workspaceName": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "brandSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "imageUrl": "<string>"
      }
    ],
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.trybloom.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
ids
string

Comma-separated image IDs to filter by (max 50). Returns only the specified images.

​
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 session 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
​
includeUrls

Include signed download URLs for completed images

​
wait
default:false

Hold the connection until every image referenced by ids reaches a terminal status. 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