Cloud Workflow:
CloudWorkflow runs an API-format ComfyUI workflow through a Cloud Offload runner. It lets you execute a workflow remotely while receiving progress updates in ComfyUI. If the run requires rental confirmation, the node requests approval through an active ComfyUI browser before continuing. This is useful when you want to run a prepared workflow through a cloud provider and inspect both its visual result and the details returned by the run.
Cloud Workflow Input Parameters:
workflow_api_json
A required text field containing the ComfyUI workflow in API JSON format. The node parses this text and requires it to be a non-empty JSON object; the default, {}, is only a placeholder and will be rejected if left unchanged. There is no stated length limit. Paste an exported API-format workflow here rather than a description of the image you want to create. The workflow determines what the remote run does.
provider
A required provider selection that tells the cloud client which provider to use. Its default is auto. The available choices come from client.provider_names() at runtime, so the source does not establish a fixed list of options or specify how auto chooses a provider. Select one of the choices shown in your installation; changing it may change where the workflow runs.
input_filename
A required text field naming the uploaded image when you connect the optional image input. Its default is cloud_input.png. The node sends the image under this name, so it needs to match the filename expected by your API workflow. If no image is connected, the node sends no image input and this setting has no effect on the submitted image data. No minimum or maximum length is specified.
timeout_seconds
A required integer setting for the cloud workflow request’s timeout. The default is 3600 seconds, the minimum is 1 second, and the maximum is 86400 seconds; the interface uses steps of 60 seconds. Allow more time for workflows you expect to run longer, while keeping in mind that a shorter timeout can end a run before it finishes.
image
An optional ComfyUI IMAGE input. When connected, the node takes the first image in the supplied batch, converts it to PNG, and sends it under input_filename. This lets an API workflow use an image supplied by an earlier node, provided that workflow expects the same filename. When left unconnected, no image is sent. There is no default image or stated size limit.
Cloud Workflow Output Parameters:
first_image
The first image the node retrieves from the result, returned as a ComfyUI IMAGE. It first looks for an image artifact to download; if none yields an image, it tries the first entry in the result’s images list. If neither provides an image, this output is a black, one-pixel placeholder rather than an indication that the workflow produced a usable picture. Use result_json to check what the run returned when the image is missing or unexpected.
result_json
A formatted text representation of the cloud client’s complete result. It can help you inspect the returned run information, including any image or artifact entries, without relying solely on the visual output. The exact fields depend on the result returned by the client; the node formats that result as indented JSON with keys sorted alphabetically.
Cloud Workflow Usage Tips:
- Export the workflow in ComfyUI’s API format and replace the default
{}before running. Check that the pasted text is a JSON object, with matching braces and quoted keys. - When supplying an image, set
input_filenameto the filename your API workflow expects. Only the first image of an input batch is uploaded by this node. - Start with
providerset toautounless you need to choose a particular provider available in your installation. The source does not specify the provider-selection rules behindauto. - Set
timeout_secondsto cover the expected run time. The default is one hour; longer tasks may need a higher value within the allowed range. - Keep an active ComfyUI browser available for runs that may request rental confirmation. If
first_imageappears black and one pixel wide, inspectresult_jsonto see whether the run returned image data.
Cloud Workflow Common Errors and Solutions:
Invalid API workflow JSON: <parser details>
- Explanation: The text in
workflow_api_jsoncannot be parsed as JSON. The message includes details from the JSON parser, such as where it found a syntax problem. - Solution: Check quotation marks, commas, and braces, then paste a valid API-format workflow and retry.
API workflow JSON must be a non-empty object
- Explanation: The JSON parses, but it is empty or is not an object. The default
{}triggers this error. - Solution: Replace it with a non-empty API-format workflow JSON object.
Rental confirmation requires an active ComfyUI browser
- Explanation: The run requested rental confirmation, but the node could not use an active ComfyUI browser to obtain it.
- Solution: Run the workflow with an active ComfyUI browser available so you can respond to the confirmation request.
Rental confirmation failed or timed out
- Explanation: A confirmation error is passed through as a
CloudOffloadError. The node waits up to300seconds for a response; the precise message depends on the confirmation failure. - Solution: Watch for the confirmation request in the ComfyUI browser and respond promptly. If it does not appear, check that the browser remains connected before retrying.
Cloud workflow request fails or exceeds its timeout
- Explanation: Errors from the cloud client can prevent the node from returning results. The provided source does not specify their exact messages;
timeout_secondsis passed to the client as the request timeout. - Solution: Read the error details shown for the run, confirm the selected provider is available, and increase
timeout_secondsif the task needs more time.
Image artifact download or decoding fails
- Explanation: After a run returns an image artifact, the node downloads it and opens it as an image. A missing artifact or unreadable image can stop the node before it returns its outputs; the exact error depends on the failure.
- Solution: Retry the run and check the cloud service’s artifact availability. If the problem repeats, use the reported error details to identify whether download or image decoding failed.
first_image is a black one-pixel image
- Explanation: This is the node’s fallback when it cannot obtain an image from an image artifact or the result’s first
imagesentry. It is not itself an error message. - Solution: Inspect
result_jsonfor returned artifacts and images, then check that your API workflow produces an image result.
