Create asset reference from existing hash

Creates a new asset reference using an existing hash from cloud storage. This avoids re-uploading file content when the underlying data already exists, which is useful for large files or when referencing well-known assets. The user provides their own metadata and tags for the new reference.

POST /api/assets/from-hash

Create asset reference from existing hash

cURL

curl --request POST \
  --url https://cloud.comfy.org/api/assets/from-hash \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "hash": "<string>",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "mime_type": "<string>",
  "user_metadata": {}
}
'

import requests

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

payload = {
    "hash": "<string>",
    "tags": ["<string>"],
    "name": "<string>",
    "mime_type": "<string>",
    "user_metadata": {}
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hash: '<string>',
    tags: ['<string>'],
    name: '<string>',
    mime_type: '<string>',
    user_metadata: {}
  })
};

fetch('https://cloud.comfy.org/api/assets/from-hash', 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/from-hash",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'hash' => '<string>',
    'tags' => [
        '<string>'
    ],
    'name' => '<string>',
    'mime_type' => '<string>',
    'user_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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/from-hash"

	payload := strings.NewReader("{\n  \"hash\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"user_metadata\": {}\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	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/from-hash")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hash\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"user_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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["Content-Type"] = 'application/json'
request.body = "{\n  \"hash\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"user_metadata\": {}\n}"

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>"
}

授权

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

API key authentication. Generate an API key from your account settings at https://platform.comfy.org/profile/api-keys. Pass the key in the X-API-Key header.

请求体

application/json

hash · string · 必填

Hash of the existing asset. Supports Blake3 (blake3:) or SHA256 (sha256:) formats

Pattern: ^(blake3|sha256):[a-f0-9]{64}$

tags · string[] · 必填

Freeform tags for the asset. Common types include "models", "input", "output", and "temp", but any tag can be used in any order.

Minimum array length: 1

name · string

Display name for the asset reference (optional)

mime_type · string

MIME type of the asset (e.g., "image/png", "video/mp4")

user_metadata · object

Custom metadata for this asset reference

响应

200

application/json

Asset reference already exists (returned existing)

id · string<uuid> · 必填

Unique identifier for the asset

name · string · 必填

Name of the asset file

size · integer<int64> · 必填

Size of the asset in bytes

created_at · string<date-time> · 必填

Timestamp when the asset was created

updated_at · string<date-time> · 必填

Timestamp when the asset was last updated

created_new · boolean · 必填

Whether this was a new asset creation (true) or returned existing (false)

asset_hash · string

Blake3 hash of the asset content

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

mime_type · string

MIME type of the asset

tags · string[]

Tags associated with the asset

user_metadata · object

Custom user metadata for the asset

preview_url · string<uri>

URL for asset preview/thumbnail

preview_id · string<uuid> | null

ID of the preview asset if available

prompt_id · string<uuid> | null

ID of the job/prompt that created this asset, if available

last_access_time · string<date-time>

Timestamp when the asset was last accessed

is_immutable · boolean

Whether this asset is immutable (cannot be modified or deleted)