ComfyUI Workflow Hub

API Documentation

← Back to Workflow Hub

API Log


                        

API Endpoints

Workflow Management

  • GET /api/workflows

    List all workflows

    Returns a list of all saved workflows with their metadata.

  • GET /api/workflows/:id

    Get workflow details

    Retrieves detailed information about a specific workflow.

  • POST /api/upload-workflow

    Upload a workflow

    Upload a new workflow JSON file with optional name and description.

  • DELETE /api/workflows/:id

    Delete a workflow

    Remove a workflow from the system.

Workflow Execution

  • POST /api/upload-image

    Upload an input image

    Upload an image to be used as input for workflow execution.

  • POST /api/execute

    Execute a workflow

    Start execution of a workflow with specified inputs.

  • GET /api/status/:sessionId

    Check execution status

    Get the current status and progress of a workflow execution.

  • GET /api/images/:filename

    Get an image

    Retrieve a generated or uploaded image file.

Real-time Updates

  • WebSocket /ws?clientId=:clientId

    WebSocket Connection

    Establish a WebSocket connection for real-time progress updates and notifications.