上传新资产

向系统上传带有相关元数据的新资产。 支持两种上传方式：

1. 直接文件上传（multipart/form-data）
2. 基于URL的上传（application/json，source: “url”）

如果具有相同哈希的资产已存在，则返回现有资产。

POST /api/assets

上传新资产

cURL

curl --request POST \
  --url https://cloud.comfy.org/api/assets \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file='@example-file' \
  --form 'tags=<string>' \
  --form id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form preview_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form 'name=<string>' \
  --form 'mime_type=<string>' \
  --form 'user_metadata=<string>'

import requests

url = "https://cloud.comfy.org/api/assets"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "tags": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "mime_type": "<string>",
    "user_metadata": "<string>"
}
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('tags', '<string>');
form.append('id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('preview_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('name', '<string>');
form.append('mime_type', '<string>');
form.append('user_metadata', '<string>');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://cloud.comfy.org/api/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.comfy.org/api/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mime_type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.comfy.org/api/assets"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mime_type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://cloud.comfy.org/api/assets")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mime_type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.comfy.org/api/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"preview_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mime_type\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user_metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "size": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_new": true,
  "asset_hash": "<string>",
  "mime_type": "<string>",
  "tags": [
    "<string>"
  ],
  "user_metadata": {},
  "preview_url": "<string>",
  "preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_access_time": "2023-11-07T05:31:56Z",
  "is_immutable": true
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "size": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_new": true,
  "asset_hash": "<string>",
  "mime_type": "<string>",
  "tags": [
    "<string>"
  ],
  "user_metadata": {},
  "preview_url": "<string>",
  "preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_access_time": "2023-11-07T05:31:56Z",
  "is_immutable": true
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

授权

X-API-Key · string · header · 必填

API密钥认证。从您的用户设置中生成API密钥 位于https://platform.comfy.org/profile/api-keys。在X-API-Key头中传递密钥。

请求体

multipart/form-dataapplication/json

file · file · 必填

要上传的资产文件

tags · string[]

资产的自由格式标签。常见类型包括"models"、"input"、"output"和"temp"，但任何标签都可以任意顺序使用。

id · string<uuid>

用于幂等创建的可选资产ID。如果提供且资产已存在，则返回现有资产。

preview_id · string<uuid>

可选预览资产ID。如果未提供，图像将使用自己的ID作为预览。

name · string

资产的显示名称

mime_type · string

资产的MIME类型（例如"image/png"、"video/mp4"）

user_metadata · string

作为字符串的自定义JSON元数据

响应

200

application/json

资产已存在（返回现有资产）

id · string<uuid> · 必填

资产的唯一标识符

name · string · 必填

资产文件的名称

size · integer<int64> · 必填

资产的字节大小

created_at · string<date-time> · 必填

资产创建的时间戳

updated_at · string<date-time> · 必填

资产最后更新的时间戳

created_new · boolean · 必填

这是否为新资产创建（是）或返回已有（否）

asset_hash · string

资产内容的 Blake3 哈希

Pattern: ^blake3:[a-f0-9]{64}$

mime_type · string

资产的 MIME 类型

tags · string[]

与资产关联的标签

user_metadata · object

资产的自定义用户元数据

preview_url · string<uri>

资产预览/缩略图的 URL

preview_id · string<uuid> | null

预览资产的 ID（如有）

prompt_id · string<uuid> | null

创建此资产的任务/提示的 ID（如有）

last_access_time · string<date-time>

资产最后访问的时间戳

is_immutable · boolean

此资产是否为不可变（不能修改或删除）