Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Issue on docs - (Comfy Cloud API) Clarify "Asset" vs "File" endpoints and document supported sources for URL-based uploads

Open
  • Is something wrong?
#754 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
api, documentation

Research direction

Start with /api-reference/cloud/asset/upload-a-new-asset and compare it with the linked /api/upload/image. Clarify the supported sources for URL uploads, the distinction between assets and files, and whether assets can be workflow inputs; done means the docs state these limits and point users to the correct upload method.

Written by the indexing model from the issue text.

Description

Path: /api-reference/cloud/asset/upload-a-new-asset

There is currently ambiguity in the documentation regarding the purpose and limitations of the /api/assets endpoint compared to the standard file upload endpoints. Specifically, the URL-based upload method for assets frequently fails with a UNSUPPORTED_SOURCE error, even when the source is publicly accessible and has no CORS restrictions.

Error Encountered: { "code": "UNSUPPORTED_SOURCE", "message": "Failed to retrieve asset from external source." }

Observed Behavior: * URL-based uploads fail for multiple media types (MP3, WAV, images) even when hosted on public S3 buckets or direct URLs.

The term "supported source" is not defined, making it impossible to know which domains or protocols are allowed.

It is unclear if assets uploaded via the /api/assets endpoint can actually be used as inputs for workflows/jobs, or if users should strictly be using the multipart form-data method on the file endpoints.

I suggest

  • clarifying "Supported Source" Explicitly listing the requirements or allowed domains for the URL-based upload method.
    maybe also add a section explaining the distinction between an Asset and a File (uploaded for a specific job/input) could prove beneficial for users referencing the docs.

  • Clearly state if assets can be used as workflow inputs and, if so, how to reference them. If they cannot, it would be nice if the documentation could explicitly point users toward the multipart form-data method for workflow inputs as users may be referencing this asset endpoint to upload inputs that are not images due to the confusion caused by the naming convention of api/upload/image. endpoint.

Dominant language
MDX
Stars
296
Forks
207
Avg merge
20h 34m
Merged PRs (30d)
187

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Comfy-Org/docs

All issues in Comfy-Org/docs

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.