Skip to content

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

@VencentSoliman

Description

@VencentSoliman

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions