Generate image
generate_imageGenerate an image from a text prompt, optionally conditioned on source images (image-to-image) and actor, product, or visual-style entity ids. Typically takes 15–60 seconds. Tell the user that wait up front.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the image to generate. | |
| quality | No | Generation quality. Omit to use workspace settings. | |
| entityIds | No | Actor, product, or visual-style references for consistent identity and appearance. Use entityId values from list_entities or create_entity, with reference files attached. | |
| aspectRatio | No | Output aspect ratio as width:height units (not pixels). Example: { width: 16, height: 9 }. | |
| imageFileIds | No | Reference images to guide the generated appearance. Use fileId values from upload_file, get_file, or list_files. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Error details when status is failed; otherwise null. | |
| status | No | Job status: pending, running, succeeded, failed, or cancelled. | |
| results | No | Generated results with download URLs when succeeded. | |
| toolType | No | Tool name (e.g. GENERATE_IMAGE). | |
| attemptIndex | No | Current or latest attempt index. | |
| toolExecutionId | Yes | Tool execution id (vg_tool_...). | |
| progressPercentage | No | Completion progress 0-100 (present after polling). |