> For the complete documentation index, see [llms.txt](https://xalora-ai.gitbook.io/xalora-ai-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://xalora-ai.gitbook.io/xalora-ai-docs/comfyui-workflow.md). # ComfyUI Workflow Execute ComfyUI workflows such as image upscaling and video generation. ## [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#introduction)Introduction ComfyUI is an open-source program that allows users to use generative AI such as text-to-image, image-to-image, text-to-video and more through a flexible node-based interface. Xalora SDK abstracts away the complexity of ComfyUI, and provides simple functions in Node.js SDK to execute ComfyUI workflows on distributed GPU miners. [SDK source code](https://github.com/XaloraAI/Xalora-sdk/tree/main/packages/workflow) ## [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#available-workflows)Available Workflows The SDK currently supports the following ComfyUI workflows: * Text to Video Generation - Generate videos from text descriptions * Image Upscaling - Upscale images while maintaining quality ## [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#core-concepts)Core Concepts Each workflow in ComfyUI is represented by a `WorkflowTask`. The SDK provides a base class that handles common functionality, which specific workflow implementations extend with their unique requirements. ## [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#before-you-start)Before you start 1. Get an API key 2. Define environment variables in `.env` file: Copy ``` XALORA_API_KEY=your_api_key XALORA_WORKFLOW_URL=https://sequencer-v2.xalora.xyz ``` ## [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#data-structures)Data Structures Each `WorkflowTask` represents a task of a specific ComfyUI workflow (identified by a JSON workflow file describing the node structures in ComfyUI). A derived class of `WorkflowTask` is defined for each individual workflow, including necessary input parameters. ### [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#base-class)Base Class Copy ``` abstract class WorkflowTask { public consumer_id?: string; public job_id_prefix?: string; public timeout_seconds?: number; public workflow_id?: string; public api_key?: string; constructor(options: WorkflowTaskOptions) { this.consumer_id = options.consumer_id; this.job_id_prefix = options.job_id_prefix; this.timeout_seconds = options.timeout_seconds; this.workflow_id = options.workflow_id; this.api_key = options.api_key; } abstract get task_type(): WorkflowTaskType; abstract get task_details(): Record; } ``` ### [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#task-option-type)Task Option Type Copy ``` interface WorkflowTaskOptions { consumer_id?: string; job_id_prefix?: string; timeout_seconds?: number; workflow_id?: string; api_key?: string; } ``` ### [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#task-result-type)Task Result Type Copy ``` interface WorkflowTaskResult { task_id: string status: 'waiting' | 'running' | 'finished' | 'failed' | 'canceled' result?: any } ``` ## [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#functions)Functions ### [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#execute-a-workflow)Execute a workflow Executes a workflow task without waiting for the result. Copy ``` async executeWorkflow(task: WorkflowTask): Promise ``` Returns a Promise that resolves to the task ID. ### [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#query-the-task-result)Query the task result Queries the result of a previously executed task. Copy ``` async queryTaskResult(task_id: string): Promise ``` Returns a Promise that resolves to the task result. ### [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#execute-a-workflow-and-wait-for-the-result)Execute a workflow and wait for the result Executes a workflow and waits until a result is returned. Internally, this function calls `queryTaskResult` at a fixed interval, and throws if the task times out. Copy ``` async executeWorkflowAndWaitForResult( task: WorkflowTask, timeout: number = 300000, interval: number = 10000 ): Promise ``` ### [](https://docs.heurist.ai/dev-guide/heurist-sdk/comfyui-workflow#cancel-a-task)Cancel a task Cancels a previously submitted task. Copy ``` async cancelTask(task_id: string): Promise<{ task_id: string; msg: string }> ``` Returns a Promise that resolves to the task ID and message. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://xalora-ai.gitbook.io/xalora-ai-docs/comfyui-workflow.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.