Skip to content

docs: document getDownloadUrl() and fix API-key placeholder#19

Merged
wei-hai merged 2 commits into
mainfrom
docs/get-download-url-and-fixes
Jul 23, 2026
Merged

docs: document getDownloadUrl() and fix API-key placeholder#19
wei-hai merged 2 commits into
mainfrom
docs/get-download-url-and-fixes

Conversation

@wei-hai

@wei-hai wei-hai commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

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

The README documented toFile() but not getDownloadUrl(), a public output
method. Adds a concise 'Downloading outputs' section covering toFile/toBytes,
range reads, and getDownloadUrl() (self-authorizing signed URL on cloud,
content endpoint on self-hosted).

Also corrects the API-key placeholder in the auth table: keys are comfyui-*,
not ck_*. Verified live against staging and prod.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@wei-hai
wei-hai requested review from a team as code owners July 23, 2026 16:24
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@wei-hai, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 2 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 46ec186b-1d2f-4867-9bfc-e249118f1807

📥 Commits

Reviewing files that changed from the base of the PR and between d922672 and 908d62f.

📒 Files selected for processing (1)
  • README.md

Warning

.coderabbit.yaml has a parsing error

The CodeRabbit configuration file in this repository has a parsing error and default settings were used instead. Please fix the error(s) in the configuration file. You can initialize chat with CodeRabbit to get help with the configuration file.

💥 Parsing errors (1)
Validation error: Too big: expected string to have <=250 characters at "tone_instructions"
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/get-download-url-and-fixes
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/get-download-url-and-fixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@wei-hai
wei-hai merged commit 890549a into main Jul 23, 2026
7 checks passed
@wei-hai
wei-hai deleted the docs/get-download-url-and-fixes branch July 23, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant