Crate comfyui_client

ComfyUI Client

Rust client for ComfyUI.

API Reference

The following table lists the available APIs in ComfyUIClient:

Method	URL	Purpose	Client Method
GET	/history/{prompt_id}	Retrieves the history for a specified prompt	get_history
GET	/prompt	Retrieves the current prompt information	get_prompt
GET	/view	Retrieves view data for a file (e.g., images)	get_view
POST	/prompt	Sends a prompt in JSON format	post_prompt
POST	/upload/image	Uploads an image to ComfyUI	upload_image

Additionally, the client establishes a WebSocket connection to /ws to receive real-time events from ComfyUI.

Examples

Refer to examples.

License

MulanPSL-2.0

Re-exports

pub use crate::errors::ClientError;

pub use crate::errors::ClientResult;

Modules

errors

Module containing error definitions.

meta

Module containing metadata such as prompt and file information.

Structs

ClientBuilder

A builder for creating a ComfyUIClient instance.

ComfyUIClient

A client for interacting with the ComfyUI service.

EventStream

A structure representing the event stream received via a websocket connection.