List Images
list_imagesList Brand Library images with pagination and filters, or read known image_ids together. For images that are pending or generating: image_url is absent.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_images"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wait | No | Hold the connection until every existing image record referenced by image_ids reaches a terminal status. Selected-model generation-job IDs are not resolved. Defaults to true when image_ids is provided, false otherwise. No-op when image_ids is omitted. | |
| limit | No | Results per page when browsing. Ignored when image_ids is provided. | |
| cursor | No | Pass next_cursor from the previous result to get the next page. | |
| source | No | Filter by image source. "generated" = AI-created, "uploaded" = user uploads, "scraped" = website images from brand onboarding | |
| status | No | Filter by generation status (only applies to generated images) | |
| timeout | No | Time to wait for the requested image_ids to reach a terminal status, in seconds. Applies when waiting is enabled. Defaults to and is capped at 45 seconds. | |
| image_ids | No | Fetch existing managed or Brand Library image IDs in one call. limit is ignored in this mode. Selected-model generation-job IDs are not accepted. | |
| llm_model | No | The model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics. | |
| action_type | No | Filter by action type (only applies to generated images) | |
| include_urls | No | Ignored — image URLs are always included because this tool has an attached UI widget that needs them to render. Kept in the schema for backward compatibility with existing callers. | |
| workspace_id | No | Scope results to one workspace by id (from list_workspaces). Omit (or pass null) to span every workspace the caller can see — each result is labeled with its workspace. | |
| brand_session_id | No | Brand whose images to list. Omit to include all brands within the selected workspace scope. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| images | Yes | Images on this page. | |
| has_more | Yes | Whether more results follow this page. | |
| brand_name | No | Name of the brand, when available for a request filtered by brand_session_id. | |
| next_cursor | Yes | Pass as cursor to get the next page. Null when no more results follow. |