Get Image
get_imageRead an image from the Brand Library by ID. Returns its status, source, dimensions, description, and workspace, with a link once the image is available.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"image_id": "<image_id>"
},
"name": "get_image"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wait | No | Hold connection until image reaches terminal status. Only applies to generated images. Recommended: true. | |
| timeout | No | Time to wait for a generated image to finish when waiting is enabled, in seconds. Defaults to and is capped at 45 seconds. | |
| image_id | Yes | Image ID (from generate, upload, or list) | |
| 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. | |
| include_url | No | Ignored — the URL is always included because this tool has an attached UI widget that needs it to render. Kept in the schema for backward compatibility with existing callers. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Image ID. | |
| width | Yes | Width in pixels, or null when not recorded. | |
| height | Yes | Height in pixels, or null when not recorded. | |
| prompt | Yes | Prompt the image was generated from, or null. | |
| source | Yes | generated, uploaded, or scraped (collected from a brand source). | |
| status | Yes | Generation status, or null when the image has none. | |
| failure | Yes | Failure details of a failed selected-model generation, or null. | |
| image_url | Yes | Link to the image, or null when a generated image is not completed. | |
| created_at | Yes | Time the image was created. | |
| action_type | Yes | Operation that produced a generated image, such as generation or edit, or null. | |
| description | Yes | Text description of the image, or null when there is none. | |
| aspect_ratio | Yes | Closest standard aspect ratio, or null when unknown. | |
| workspace_id | Yes | Workspace ID, or null for a personal workspace that has no ID. | |
| failure_reason | Yes | Coarse reason generation failed, or null. A selected-model generation reports its details in failure on get_image instead. | |
| workspace_name | Yes | Name of the workspace that owns the image. | |
| brand_session_id | No | Brand session ID of the image's brand, when included. | |
| variant_group_id | Yes | ID of the image's variant group, or null when it has none. |