Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api-reference/v2/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Comfy API v2 Overview"
sidebarTitle: "Overview"
description: "Reference for the official Comfy API v2: run ComfyUI workflows from external applications by uploading inputs, submitting jobs, and polling for results."
keywords: ["ComfyAPI", "Comfy API"]
---

<Warning>
Expand All @@ -27,7 +28,7 @@
comfy-api-proxy
```

By default it proxies the ComfyUI on `127.0.0.1:8188` and serves the v2 API on `127.0.0.1:8189`, binding to loopback only. Authentication is off by default, with an optional static bearer token. The proxy is a stopgap: once v2 stabilizes it moves into ComfyUI core and the proxy is no longer needed. See [Your own ComfyUI](/development/api-development/sdks#your-own-comfyui) in the SDK guide for configuration details.

Check warning on line 31 in api-reference/v2/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

api-reference/v2/overview.mdx#L31

Did you really mean 'loopback'?

## Design Principles

Expand All @@ -51,7 +52,7 @@
| Category | Description |
|----------|-------------|
| Assets | UUID-identified records over content-addressed blobs. Upload inputs, download outputs. |
| Jobs | One execution of a workflow. Durable, pollable, and cancelable. |

Check warning on line 55 in api-reference/v2/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

api-reference/v2/overview.mdx#L55

Did you really mean 'pollable'?

## Comfy Router

Expand Down
2 changes: 1 addition & 1 deletion custom-nodes/v3_migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@

## Migration Steps

Going from V1 to V3 should be simple in most cases and is simply a syntax change.

Check warning on line 76 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L76

Did you really mean 'define_schema'?

### Step 1: Change Base Class

Expand Down Expand Up @@ -207,7 +207,7 @@

### Step 5: Handle Special Methods

The same special methods are supported as in v1, but either lowercased or renamed entirely to be more clear. Their usage remains the same.

Check warning on line 210 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L210

Did you really mean 'lowercased'?

#### Validation (V1 → V3)

Expand Down Expand Up @@ -278,7 +278,7 @@

### Step 6: Create Extension and Entry Point

Instead of defining dictionaries to link node id to node class/display name, there is now a ```ComfyExtension``` class and an expected ```comfy_entrypoint``` function to be defined.

Check warning on line 281 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L281

Did you really mean 'control_after_generate'?

In the future, more functions may be added to ComfyExtension to register more than just nodes via ```get_node_list```.

Expand Down Expand Up @@ -347,7 +347,7 @@

### ComfyUI Types

| V1 Type | V3 Type | Example |

Check warning on line 350 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L350

Did you really mean 'Tooltip'?
|---------|---------|---------|
| `"IMAGE"` | `io.Image.Input()` | `io.Image.Input("image", tooltip="Input image")` |
| `"MASK"` | `io.Mask.Input()` | `io.Mask.Input("mask", optional=True)` |
Expand Down Expand Up @@ -381,12 +381,12 @@
| `display_name` | `str` | `None` | Display name shown in the UI. Falls back to `node_id` if not set. |
| `category` | `str` | `"sd"` | Category in the "Add Node" menu (e.g. `"image/transform"`). |
| `description` | `str` | `""` | Tooltip shown when hovering over the node. |
| `inputs` | `list[Input]` | `[]` | List of input definitions. |

Check warning on line 384 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L384

Did you really mean 'kwargs'?
| `outputs` | `list[Output]` | `[]` | List of output definitions. |
| `hidden` | `list[Hidden]` | `[]` | List of hidden inputs to request (see [Hidden Inputs](#hidden-inputs)). |
| `search_aliases` | `list[str]` | `[]` | Alternative names for search. Useful for synonyms or old names after renaming. |

Check warning on line 387 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L387

Did you really mean 'kwarg'?
| `is_output_node` | `bool` | `False` | Marks the node as an output node, causing it and its dependencies to be executed. |
| `is_input_list` | `bool` | `False` | When True, all inputs become `list[type]` regardless of how many items are passed in. |

Check warning on line 389 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L389

Did you really mean 'tooltip'?
| `is_deprecated` | `bool` | `False` | Flags the node as deprecated, signaling users to find alternatives. |
| `is_experimental` | `bool` | `False` | Flags the node as experimental, warning users it may change. |
| `is_dev_only` | `bool` | `False` | Hides the node from search/menus unless dev mode is enabled. |
Expand Down Expand Up @@ -505,7 +505,7 @@

#### Save Helpers

Save helpers provide methods for saving files to the output directory with proper metadata embedding. They are typically used in output nodes.

Check warning on line 508 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L508

Did you really mean 'Dicts'?

```python
from comfy_api.latest import ui, io
Expand Down Expand Up @@ -555,7 +555,7 @@
```

<Tip>
Passing `cls=cls` to save/preview helpers allows them to automatically embed workflow metadata (prompt, extra_pnginfo) in the saved files. Make sure to include `io.Hidden.prompt` and `io.Hidden.extra_pnginfo` in your schema's hidden list, or set `is_output_node=True` which adds them automatically.

Check warning on line 558 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L558

Did you really mean 'extra_pnginfo'?

Check warning on line 558 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L558

Did you really mean 'schema's'?
</Tip>

#### Returning Raw UI Dicts
Expand Down Expand Up @@ -699,7 +699,7 @@
)
```

Autogrow can be combined with MatchType to create lists of type-matched inputs:

Check warning on line 702 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L702

Did you really mean 'Autogrow'?

```python
@classmethod
Expand Down Expand Up @@ -783,7 +783,7 @@

### Async Execute

V3 supports async `execute` methods. This is useful for nodes that perform I/O operations, API calls, or other async work. Simply declare `execute` as `async`:

Check warning on line 786 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L786

Did you really mean 'io'?

```python
@classmethod
Expand All @@ -792,7 +792,7 @@
return io.NodeOutput(result)
```

### ComfyAPI
### Comfy API runtime services {#comfyapi}

The `ComfyAPI` class provides access to ComfyUI runtime services like progress reporting and node replacement registration. Import it and create an instance:

Expand Down Expand Up @@ -858,7 +858,7 @@

The `old_widget_ids` parameter is important: workflow JSON stores widget values by position index, not by name. This list maps those positional indexes to input IDs so the replacement system can correctly identify widget values during migration.

For nodes using dynamic inputs (like Autogrow), use dotted paths in the mapping:

Check warning on line 861 in custom-nodes/v3_migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

custom-nodes/v3_migration.mdx#L861

Did you really mean 'Autogrow'?

```python
input_mapping=[
Expand Down
1 change: 1 addition & 0 deletions development/comfy-api/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: "Comfy API"
sidebarTitle: "Overview"
description: "The public API for running ComfyUI workflows headlessly"

Check warning on line 4 in development/comfy-api/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/comfy-api/overview.mdx#L4

Did you really mean 'headlessly'?
keywords: ["ComfyAPI", "Comfy API"]
---

The public API for running ComfyUI headlessly has evolved over time. For new integrations, use [Comfy API v2](/api-reference/v2/overview). It is supported on open-source ComfyUI (during the beta, via the [API Proxy](/development/comfyui-server/api-proxy)), Comfy Cloud, and [Comfy API deployments on the Developer Platform](/development/serverless/overview). Older versions include the [v1 Cloud API](/development/cloud/overview), which is deprecated.

Check warning on line 8 in development/comfy-api/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/comfy-api/overview.mdx#L8

Did you really mean 'headlessly'?

<CardGroup cols={2}>
<Card title="Comfy API v2" icon="cloud" href="/api-reference/v2/overview">
Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -3110,6 +3110,7 @@
"development/api-development/workflow-metadata",
{
"group": "Comfy API Reference",
"boost": 10,
"pages": [
"development/comfy-api/overview",
{
Expand Down
Loading