invokeai_queue
Inspect, control, and harvest InvokeAI queue items: check status, list jobs, cancel batches, and retrieve generated image results.
Instructions
Manage the InvokeAI generation queue and retrieve results.
[RATIONALE] Queue lifecycle (inspect, control, and harvest outputs) is one domain, so all operations share this portmanteau. 'result' is the natural partner of invokeai_generate: it polls an item to completion and returns the output image URLs (or downloads the file locally).
Return Format
{"success": bool, "operation": str, "data": {...}, "message": str}
Examples
invokeai_queue(operation="status") invokeai_queue(operation="list", status_filter="completed", limit=10) invokeai_queue(operation="result", item_id=123, wait_seconds=120, download_image=True) invokeai_queue(operation="cancel_batch", batch_ids=["batch-uuid"])
Notes:
result polls every 3s up to wait_seconds; use wait_seconds for synchronous flows.
Without wait_seconds, result returns the current item state immediately.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max items to list. | |
| item_id | No | Queue item id (required for item_status, result, cancel). | |
| batch_ids | No | Batch ids to cancel (cancel_batch). | |
| operation | Yes | Queue operation to perform. | |
| wait_seconds | No | For 'result': poll until the item completes (max seconds), then return outputs. | |
| status_filter | No | Filter list by status (pending, in_progress, completed, failed, canceled). | |
| download_image | No | For 'result': save the output image to the local download dir and return its path. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||