# Interface: ComfyUIImageModelOptions (/jsdoc/pixi-vn-ai/comfyui/interfaces/ComfyUIImageModelOptions)



Defined in: [src/comfyui/ComfyUIImageModel.ts:11](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L11)

## Properties [#properties]

### apiHost [#apihost]

\> **apiHost**: `string`

Defined in: [src/comfyui/ComfyUIImageModel.ts:15](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L15)

The ComfyUI server address, e.g. `"127.0.0.1:8188"` or `"my-comfyui.example.com"`.

***

### promptInputName? [#promptinputname]

\> `optional` **promptInputName?**: `string`

Defined in: [src/comfyui/ComfyUIImageModel.ts:37](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L37)

The name of the input on [promptNodeId](#promptnodeid) that holds the prompt text.

#### Default [#default]

```ts
"text"
```

***

### promptNodeId [#promptnodeid]

\> **promptNodeId**: `string`

Defined in: [src/comfyui/ComfyUIImageModel.ts:32](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L32)

The ID of the node (as it appears in [workflow](#workflow)) whose input holds the positive
prompt text (typically a `CLIPTextEncode` node).

***

### ssl? [#ssl]

\> `optional` **ssl?**: `boolean`

Defined in: [src/comfyui/ComfyUIImageModel.ts:20](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L20)

Whether to connect over SSL/WSS.

#### Default [#default-1]

```ts
false
```

***

### timeoutMs? [#timeoutms]

\> `optional` **timeoutMs?**: `number`

Defined in: [src/comfyui/ComfyUIImageModel.ts:42](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L42)

Milliseconds to wait for the workflow to finish before giving up.

#### Default [#default-2]

```ts
300000 (5 minutes)
```

***

### workflow [#workflow]

\> **workflow**: `Record`\<`string`, `unknown`>

Defined in: [src/comfyui/ComfyUIImageModel.ts:27](https://github.com/DRincs-Productions/pixi-vn-ai/blob/f5205e28d51c043e8eeb27fcb2b61433f3751ac2/src/comfyui/ComfyUIImageModel.ts#L27)

The ComfyUI workflow to run, exported in **API format** (ComfyUI menu: "Save (API Format)").
Pixi'VN AI has no way to know how your workflow is structured (checkpoint, sampler, custom
nodes, ...), so you provide it, along with where to inject the prompt via
[promptNodeId](#promptnodeid)/[promptInputName](#promptinputname).