Add a runnable first Workflow API example

[stale2000]

Summary

• Add a focused Workflow API quickstart with a bundled model-free workflow.
• Add runnable Python and TypeScript clients that submit the workflow and save its output.
• Add the quickstart to the Run Workflows navigation.

Validation

• mint validate
• mint broken-links
• JSON, Python, and Node syntax checks
• git diff --check

No live Comfy Cloud request was made; remote execution and downloads were mocked.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
comfy	🟢 Ready	View Preview	Sep 14, 2026, 11:40 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

[github-actions]

🌐 i18n translation sync reminder

@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files:

Japanese (ja)

• ja/development/api-development/quickstart.mdx
• ja/development/api-development/quickstart.mdx

Simplified Chinese (zh)

• zh/development/api-development/quickstart.mdx
• zh/development/api-development/quickstart.mdx

Korean (ko)

• ko/development/api-development/quickstart.mdx
• ko/development/api-development/quickstart.mdx

---

Local sync: npm run translate (see README — Automated translation)

[coderabbitai]

Warning

Review limit reached

• Run on-demand review

_{On-demand reviews are free for the next 24 days. After that, they cost $0.25 per reviewed file.}

Or wait 17 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: e111f27e-a977-4854-bc0b-6ee8a52f3d93

📥 Commits

Reviewing files that changed from the base of the PR and between ba377f6 and b03d4e5.

📒 Files selected for processing (1)

• docs.json

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 6e719ce5-cf83-40c9-9381-903052bd7c9b

📥 Commits

Reviewing files that changed from the base of the PR and between 0b33a79 and ba377f6.

📒 Files selected for processing (7)

• development/api-development/getting-an-api-key.mdx
• development/api-development/quickstart.mdx
• development/overview.mdx
• docs.json
• files/api-first-result/first_workflow.mts
• files/api-first-result/first_workflow.py
• files/api-first-result/workflow_api.json

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.

---

📝 Walkthrough

Walkthrough

The PR updates API onboarding content, adds a Workflow API quickstart, registers it in navigation, and provides Python and TypeScript examples with a bundled workflow.

Changes

Workflow API onboarding

Layer / File(s)	Summary
API access and key setup development/overview.mdx, development/api-development/getting-an-api-key.mdx	The documentation distinguishes Comfy Router from the Workflow API. It adds API key setup, security guidance, prerequisites, and quickstart links.
First-workflow quickstart development/api-development/quickstart.mdx, docs.json	The new guide covers prerequisites, SDK setup, workflow execution, output download, troubleshooting, and custom workflows. Navigation includes the guide under “Run Workflows.”
Runnable workflow examples files/api-first-result/workflow_api.json, files/api-first-result/first_workflow.py, files/api-first-result/first_workflow.mts	The examples load a bundled EmptyImage and SaveImage workflow, require COMFY_API_KEY, execute it through the SDK, and save the output image.

Suggested reviewers: lin-bot23

Sequence Diagram(s)

sequenceDiagram
  participant Developer
  participant Quickstart
  participant ComfySDK
  participant WorkflowAPI
  participant OutputFile
  Developer->>Quickstart: Follow setup instructions
  Quickstart->>ComfySDK: Configure with COMFY_API_KEY
  ComfySDK->>WorkflowAPI: Submit workflow_api.json
  WorkflowAPI-->>ComfySDK: Return SaveImage output
  ComfySDK-->>OutputFile: Save first-result.png

Loading

Priority: ➖ Normal

Merge Risk: ⚪ Minimal · up to ba377

The new onboarding links and documented SDK base-URL guidance are consistent, with no actionable merge risk identified.

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/api-first-result

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch codex/api-first-result

---

_{Comment @coderabbitai help to get the list of available commands.}

[stale2000]

The focused first-workflow changes were moved into #1686, which now owns the complete developer-onboarding update.