[PR #16] [MERGED] docs: document get_download_url() and fix API-key/host placeholders #24

New issue

Closed

opened 2026-10-26 22:40:46 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-26 22:40:46 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/16
Author: @wei-hai
Created: 7/23/2026
Status: ✅ Merged
Merged: 7/23/2026
Merged by: @wei-hai

Base: main ← Head: docs/get-download-url-and-fixes

📝 Commits (1)

58a539e docs: document get_download_url() and fix API-key/host placeholders

📊 Changes

2 files changed (+32 additions, -5 deletions)

View changed files

📝 README.md (+31 -4)
📝 src/comfy_sdk/__init__.py (+1 -1)

📄 Description

What

Documents the previously-undocumented get_download_url() and fixes two inaccurate placeholders in the docs.

Changes

New "Downloading outputs" section — covers to_file / to_bytes, range reads, and get_download_url(). The README previously only showed to_file.
API-key placeholder ck_... → comfyui-... (3 spots) — verified the real key prefix live against staging and prod.
__init__.py docstring host cloud.comfy.org → api.comfy.org — the old host 404s; api.comfy.org is the Comfy Cloud v2 endpoint.

Verified

get_download_url() was exercised end-to-end against staging and prod: returns a self-authorizing GCS signed URL with an expires_at, fetchable with no API key (HTTP 200). Hygiene scanner + package import pass. Docs-only; no code behavior change.

🤖 Generated with Claude Code

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-python-sdk/pull/16 **Author:** [@wei-hai](https://github.com/wei-hai) **Created:** 7/23/2026 **Status:** ✅ Merged **Merged:** 7/23/2026 **Merged by:** [@wei-hai](https://github.com/wei-hai) **Base:** `main` ← **Head:** `docs/get-download-url-and-fixes` --- ### 📝 Commits (1) - [`58a539e`](https://github.com/Comfy-Org/comfy-python-sdk/commit/58a539eb54b3486bc4f96fd1100f41cd60652801) docs: document get_download_url() and fix API-key/host placeholders ### 📊 Changes **2 files changed** (+32 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+31 -4) 📝 `src/comfy_sdk/__init__.py` (+1 -1) </details> ### 📄 Description ## What Documents the previously-undocumented `get_download_url()` and fixes two inaccurate placeholders in the docs. ## Changes - **New "Downloading outputs" section** — covers `to_file` / `to_bytes`, range reads, and `get_download_url()`. The README previously only showed `to_file`. - **API-key placeholder `ck_...` → `comfyui-...`** (3 spots) — verified the real key prefix live against staging and prod. - **`__init__.py` docstring host `cloud.comfy.org` → `api.comfy.org`** — the old host 404s; `api.comfy.org` is the Comfy Cloud v2 endpoint. ## Verified `get_download_url()` was exercised end-to-end against **staging and prod**: returns a self-authorizing GCS signed URL with an `expires_at`, fetchable with no API key (HTTP 200). Hygiene scanner + package import pass. Docs-only; no code behavior change. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-26 22:40:46 +00:00