[PR #19] [MERGED] docs: document getDownloadUrl() and fix API-key placeholder #29

New issue

Closed

opened 2026-10-31 22:03:57 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:03:57 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-typescript-sdk/pull/19
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 (2)

aba6c2d docs: document getDownloadUrl() and fix API-key placeholder
908d62f docs: apply oxfmt formatting to README

📊 Changes

1 file changed (+31 additions, -5 deletions)

View changed files

📝 README.md (+31 -5)

📄 Description

What

Documents the previously-undocumented getDownloadUrl() and fixes the API-key placeholder.

Changes

New "Downloading outputs" section — covers toFile / toBytes, range reads, and getDownloadUrl(). The README previously only showed toFile.
Auth-table placeholder ck_... → comfyui-... — verified the real key prefix live against staging and prod.

Verified

The download-URL contract was exercised end-to-end against staging and prod via the sibling Python SDK (same low-level endpoint): a self-authorizing signed URL with an expiry, fetchable with no API key (HTTP 200). Hygiene scanner passes. 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-typescript-sdk/pull/19 **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 (2) - [`aba6c2d`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/aba6c2dfc5d9ebe112ca5f5520a037bb7baf1455) docs: document getDownloadUrl() and fix API-key placeholder - [`908d62f`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/908d62fb5750cd8911027940fbf83059f5d2b029) docs: apply oxfmt formatting to README ### 📊 Changes **1 file changed** (+31 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+31 -5) </details> ### 📄 Description ## What Documents the previously-undocumented `getDownloadUrl()` and fixes the API-key placeholder. ## Changes - **New "Downloading outputs" section** — covers `toFile` / `toBytes`, range reads, and `getDownloadUrl()`. The README previously only showed `toFile`. - **Auth-table placeholder `ck_...` → `comfyui-...`** — verified the real key prefix live against staging and prod. ## Verified The download-URL contract was exercised end-to-end against **staging and prod** via the sibling Python SDK (same low-level endpoint): a self-authorizing signed URL with an expiry, fetchable with no API key (HTTP 200). Hygiene scanner passes. 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-31 22:03:57 +00:00