List user assets

Retrieves a paginated list of assets belonging to the authenticated user. Supports filtering by tags, name, metadata, and sorting options.

GET /api/assets

List user assets

cURL

curl --request GET \
  --url https://cloud.comfy.org/api/assets \
  --header 'X-API-Key: <api-key>'

200

{
  "assets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "size": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "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
    }
  ],
  "total": 123,
  "has_more": true
}

授权

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

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.

查询参数

include_tags · string[]

Filter assets that have ALL of these tags

exclude_tags · string[]

Exclude assets that have ANY of these tags

name_contains · string

Filter assets where name contains this substring (case-insensitive)

metadata_filter · string

JSON object for filtering by metadata fields

limit · integer · 默认值: 20

Maximum number of assets to return (1-500)

必填范围: 1 <= x <= 500

offset · integer · 默认值: 0

Number of assets to skip for pagination

必填范围: x >= 0

sort · enum<string> · 默认值: created_at

Field to sort by

可用选项: name, created_at, updated_at, size, last_access_time

order · enum<string> · 默认值: desc

Sort order

可用选项: asc, desc

include_public · boolean · 默认值: true

Whether to include public/shared assets in results

响应

200

application/json

Success - Assets returned

assets · object[] · 必填

List of assets matching the query

显示 子属性

total · integer · 必填

Total number of assets matching the filters

has_more · boolean · 必填

Whether more assets are available beyond this page