comfydeploy

Documentation

Overview

Package comfydeploy implements engine.Engine for the ComfyDeploy API.

Workflow execution is async: POST /run creates a run, then GET /run?run_id={id} polls for completion. Auth: Authorization: Bearer {token}, env COMFYDEPLOY_API_TOKEN.

Index

• Variables
• func ConfigSchema() []engine.ConfigField
• func DefaultProvider() engine.Provider
• func ModelInfos() []engine.ModelInfo
• func ModelsByCapability() map[string][]string
• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) Capabilities() engine.Capability
  • func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)
  • func (e *Engine) Resume(ctx context.Context, remoteID string) (engine.Result, error)

Variables

var ErrMissingDeploymentID = fmt.Errorf("comfydeploy: deployment ID is required")

Functions

func ConfigSchema

func ConfigSchema() []engine.ConfigField

ConfigSchema returns the configuration fields required by the ComfyDeploy engine.

func DefaultProvider

func DefaultProvider() engine.Provider

DefaultProvider returns preset engine configurations for comfydeploy.

func ModelInfos

func ModelInfos() []engine.ModelInfo

ModelInfos returns i18n metadata for the ComfyDeploy platform. ComfyDeploy models are hosted ComfyUI workflows; this registers a platform-level entry for discovery purposes.

func ModelsByCapability

func ModelsByCapability() map[string][]string

ModelsByCapability returns the models grouped by capability.

Types

type Config

type Config struct {
	APIToken          string
	BaseURL           string
	DeploymentID      string // required
	HTTPClient        *http.Client
	WaitForCompletion bool
	PollInterval      time.Duration
	Webhook           string // optional
	OnProgress        epoll.OnProgress
}

Config configures the ComfyDeploy engine.

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine implements engine.Engine for ComfyDeploy.

func New

func New(cfg Config) *Engine

New creates a ComfyDeploy engine instance.

func (*Engine) Capabilities

func (e *Engine) Capabilities() engine.Capability

Capabilities implements engine.Describer.

func (*Engine) Execute

func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)

Execute runs a workflow on ComfyDeploy.

func (*Engine) Resume

func (e *Engine) Resume(ctx context.Context, remoteID string) (engine.Result, error)

Resume implements engine.Resumer — resumes polling a previously submitted run.