v1

latestOpenAPI 3.1.02026-07-224941145.6 KB

List Assets

Query assets with optional filters. This is a read-only operation and is not billed. Use GetAsset polling to confirm assets are Active before referencing them as asset://<asset_id>.

post/volc/asset/ListAssets

Request body

modelstring required

Model name. Default: volc-asset.

PageNumberinteger

Page number. Default: 1.

PageSizeinteger

Items per page. Default: 10.

Example request

{
  "model": "volc-asset",
  "Filter": {
    "Name": "test",
    "GroupIds": [
      "group-20260320141746-zsf6b"
    ],
    "GroupType": "LivenessFace"
  },
  "PageNumber": 1,
  "PageSize": 10
}

Response

Assets retrieved

PageNumberinteger

PageSizeinteger

TotalCountinteger

Example response

{
  "Items": [
    {
      "Id": "asset-20260320142452-2htjn",
      "Name": "test",
      "URL": "https://ark-media-asset.tos-cn-beijing.volces.com/...",
      "AssetType": "Image",
      "GroupId": "group-20260320141746-zsf6b",
      "Status": "Active",
      "Error": {
        "Code": "FaceMismatch",
        "Message": "Face consistency verification failed."
      },
      "ProjectName": "default",
      "CreateTime": "2026-03-20T14:24:52Z",
      "UpdateTime": "2026-03-20T14:25:01Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2
}