Update asset metadata

Updates an asset’s metadata. At least one field must be provided. Only name, tags, and user_metadata can be updated.

PUT /api/assets/{id}

Update asset metadata

cURL

curl --request PUT \
  --url https://cloud.comfy.org/api/assets/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "mime_type": "<string>",
  "preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_metadata": {}
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "asset_hash": "<string>",
  "tags": [
    "<string>"
  ],
  "mime_type": "<string>",
  "user_metadata": {}
}

Authorizations

X-API-Key · string · header · required

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

Path Parameters

id · string<uuid> · required

Asset ID

Body

application/json

name · string

New display name for the asset

tags · string[]

Updated tags for the asset

mime_type · string

Updated MIME type of the asset

preview_id · string<uuid>

Updated preview asset ID

user_metadata · object

Updated custom metadata

Response

200

application/json

Asset updated successfully

id · string<uuid> · required

Asset ID

updated_at · string<date-time> · required

Timestamp of the update

name · string

Updated name of the asset

asset_hash · string

Blake3 hash of the asset content

tags · string[]

Updated tags for the asset

mime_type · string

Updated MIME type of the asset

user_metadata · object

Updated custom metadata