Skip to content

docs: add Assets vs Files comparison guide (supersedes #806)#1308

Open
lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/assets-vs-files-guide
Open

docs: add Assets vs Files comparison guide (supersedes #806)#1308
lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/assets-vs-files-guide

Conversation

@lin-bot23

Copy link
Copy Markdown
Contributor

Implements a new guide clarifying the distinction between Comfy Cloud Assets API (/api/assets) and File API (/api/upload/image).

Responds to feedback on PR #806 from @DialloWill.

Summary

  • New page: development/cloud/assets-vs-files.mdx
  • Registered in docs.json under Cloud API group

Fixes relative to #806

  • Frontmatter: Added title and description consistent with sibling pages
  • Navigation: Placed under development/cloud/ (Cloud API Reference tab is auto-generated from OpenAPI spec, cannot host manual MDX pages)
  • Em dashes: All 6 instances replaced with colons or hyphens
  • ASCII decision tree: Wrapped in ```text fence to prevent MDX collapse
  • Curl quoting: Fixed missing closing quote on X-API-Key: ***" header (both examples)
  • URL requirement: Changed "The URL must use https://" to neutral "The URL must be reachable by Comfy Cloud servers"; OpenAPI spec says format: uri / "HTTP/HTTPS URL"
  • Supported Sources: Removed speculative constraints; kept only error codes that match spec responses (403/404/415/422)
  • "Using Assets as Workflow Inputs": Removed unverified claim; replaced with <Info> note linking issue Issue on docs - (Comfy Cloud API) Clarify "Asset" vs "File" endpoints and document supported sources for URL-based uploads #754
  • Blockquote: Converted > **Recommendation:** to Mintlify <Note> component
  • Separators: Removed all --- horizontal rules

Source

Checklist

  • No em dashes in new content
  • docs.json valid JSON
  • Only changed files: development/cloud/assets-vs-files.mdx (new) and docs.json (modified)

This guide clarifies the distinction between the Assets API and File API,
covering upload methods, deduplication behavior, and URL-based source
requirements.

Supersedes PR Comfy-Org#806, with the following fixes:
- Added Mintlify frontmatter (title, description)
- Registered in docs.json under development/cloud/
- Replaced em dashes with colons/hyphens
- Wrapped ASCII decision tree in text fence
- Fixed broken curl quoting (missing closing quote on header)
- Removed speculative URL source requirements; use conservative wording
- Removed unverified "Using Assets as Workflow Inputs" section;
  replaced with Info note linking issue Comfy-Org#754
- Changed blockquote recommendation to Mintlify Note component
- Removed redundant --- section separators
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 43 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: d0736809-f73d-4193-a5ee-9c632dc86ed1

📥 Commits

Reviewing files that changed from the base of the PR and between 4970189 and 5659a41.

📒 Files selected for processing (2)
  • development/cloud/assets-vs-files.mdx
  • docs.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified code

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.

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