> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-feat-openapi-i18n.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 从远程URL获取资产元数据

> 从远程下载 URL 检索资产的元数据，而无需下载整个文件。
支持包括 CivitAI 和其他模型存储库在内的各种来源。
使用 HEAD 请求或 API 调用高效获取元数据。
此端点用于下载前预览元数据，而非获取现有资产的元数据。




## OpenAPI

````yaml /openapi/cloud.zh.yaml get /api/assets/remote-metadata
openapi: 3.0.3
info:
  title: Comfy Cloud API
  description: >
    <警告>

    **实验性API：** 此API是实验性的，可能会更改。

    端点、请求/响应格式和行为可能在未经通知的情况下修改。

    </警告>


    用于Comfy Cloud的API - 在云基础设施上运行ComfyUI工作流。


    此API允许您以编程方式与Comfy Cloud交互，包括：

    - 提交和管理工作流

    - 上传和下载文件

    - 监控作业状态和进度


    ## 云端与OSS ComfyUI兼容性


    Comfy Cloud实现了与OSS ComfyUI相同的API接口以实现最大兼容性，

    但某些字段为了兼容性被接受，但处理方式不同或被忽略：


    | 字段 | 端点 | 云端行为 |

    |-------|-----------|----------------|

    | `subfolder` | `/api/view`, `/api/upload/*` | **忽略** -
    云端使用内容寻址存储（基于哈希）。在响应中返回用于客户端组织。 |

    | `type` (input/output/temp) | `/api/view`, `/api/upload/*` | 部分使用 -
    所有文件使用基于标签的组织存储，而非目录结构。 |

    | `overwrite` | `/api/upload/*` | **忽略** - 内容寻址存储意味着相同内容始终具有相同哈希。 |

    | `number`, `front` | `/api/prompt` | **忽略** - 云端使用自己的每个用户公平队列调度。 |

    | `split`, `full_info` | `/api/userdata` | **忽略** - 云端始终返回完整文件元数据。 |


    这些字段保留在API模式中，以便与现有ComfyUI客户端和工作流进行即插即用兼容。
  version: 1.0.0
  license:
    name: GNU General Public License v3.0
    url: https://github.com/Comfy-Org/ComfyUI/blob/master/LICENSE
servers:
  - url: https://cloud.comfy.org
    description: Comfy Cloud API
security:
  - ApiKeyAuth: []
tags:
  - name: workflow
    description: |
      提交工作流执行并管理执行队列。
      这是在云端运行ComfyUI工作流的主要方式。
  - name: job
    description: |
      监控任务状态、查看执行历史和管理运行中的任务。
      任务通过POST /api/prompt提交工作流时创建。
  - name: asset
    description: |
      上传、下载和管理持久资产（图像、模型、输出）。
      资产提供持久存储，支持标签和元数据。
  - name: file
    description: |
      与传统本地ComfyUI兼容的传统文件上传和下载端点。
      对于新的集成，请考虑使用资产API。
  - name: model
    description: |
      浏览可用的AI模型。模型已预加载到云端基础设施上。
  - name: node
    description: |
      获取可用ComfyUI节点及其输入/输出的信息。
      对构建动态工作流界面很有用。
  - name: user
    description: |
      用户账户信息和个人数据存储。
  - name: system
    description: |
      服务器状态、健康检查和系统信息。
paths:
  /api/assets/remote-metadata:
    get:
      tags:
        - asset
      summary: 从远程URL获取资产元数据
      description: |
        从远程下载 URL 检索资产的元数据，而无需下载整个文件。
        支持包括 CivitAI 和其他模型存储库在内的各种来源。
        使用 HEAD 请求或 API 调用高效获取元数据。
        此端点用于下载前预览元数据，而非获取现有资产的元数据。
      operationId: getRemoteAssetMetadata
      parameters:
        - name: url
          in: query
          required: true
          description: 从哪个下载 URL 检索元数据
          schema:
            type: string
            format: uri
            example: https://civitai.com/api/download/models/123456
      responses:
        '200':
          description: 元数据检索成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetMetadataResponse'
        '400':
          description: 无效的 URL 或缺少必填参数
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 未授权
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: 从来源检索元数据失败
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 内部服务器错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AssetMetadataResponse:
      type: object
      required:
        - content_length
      properties:
        content_length:
          type: integer
          format: int64
          description: 资产的字节大小（-1 表示未知）
          example: 4294967296
        content_type:
          type: string
          description: 资产的 MIME 类型
          example: application/octet-stream
        filename:
          type: string
          description: 从来源建议的资产文件名
          example: realistic-vision-v5.safetensors
        name:
          type: string
          description: 从来源的资产显示名称或标题
          example: Realistic Vision v5.0
        tags:
          type: array
          items:
            type: string
          description: 来自来源的分类标签
          example:
            - models
            - checkpoint
        preview_image:
          type: string
          description: 作为 base64 编码的数据 URL 的预览图像
          example: data:image/jpeg;base64,/9j/4AAQSkZJRg...
        validation:
          $ref: '#/components/schemas/ValidationResult'
          description: 文件的验证结果
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
    ValidationResult:
      type: object
      required:
        - is_valid
      properties:
        is_valid:
          type: boolean
          description: 总体验证状态（如果所有检查通过则为是）
          example: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: 阻止下载的阻塞性验证错误
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: 非阻塞性验证警告（仅用于信息参考）
    ValidationError:
      type: object
      required:
        - code
        - message
        - field
      properties:
        code:
          type: string
          description: 机器可读的错误码
          example: FORMAT_NOT_ALLOWED
        message:
          type: string
          description: 人类可读的报错信息
          example: >-
            File format "PickleTensor" is not allowed. Allowed formats:
            [SafeTensor]
        field:
          type: string
          description: 验证失败的字段
          example: format
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        API密钥认证。从您的用户设置中生成API密钥
        位于https://platform.comfy.org/profile/api-keys。在X-API-Key头中传递密钥。

````