Skip to main content

List Assets

GET /api/volc-user/assets

Retrieve a paginated list of the current user's assets, with support for filtering by asset group, status, name, and sorting.

Authentication

User console API requiring logged-in user identity (session Cookie, or Authorization: <access_token>, token obtained via Generate Access Token). This token is different from the sk- keys used for model invocation.

Query Parameters​

NameTypeRequiredDescription
pageNumberintegerOptionalPage number, starting from 1, default 1
pageSizeintegerOptionalItems per page, default 20, max 100
assetStatusintegerOptionalPlatform asset status: 1 active, 2 disabled
statusesinteger[]OptionalVolcengine status list: 1 Active, 2 Processing, 3 Failed; supports repeated params or comma-separated
groupIdsstring[]OptionalAsset group ID list, supports repeated params or comma-separated
groupTypestringRequiredAsset group type, typically AIGC
projectNamestringOptionalVolcengine project name
namestringOptionalFuzzy search by asset name
sortBystringOptionalSort field: Id, CreateTime, UpdateTime, Name
sortOrderstringOptionalSort order: Asc ascending, others descending

Request Example​

GET /api/volc-user/assets?pageNumber=1&pageSize=20&assetStatus=1&statuses=1&statuses=2&groupIds=group-7f2b8d9c&groupType=AIGC&name=model&sortBy=CreateTime&sortOrder=Desc

Response Fields (200)​

NameTypeDescription
successbooleanSuccess flag
messagestringMessage
dataobjectPagination object
data.totalCountintegerTotal count
data.pageNumberintegerCurrent page number
data.pageSizeintegerItems per page
data.itemsarray<object>Asset list
data.items[].idstringAsset ID
data.items[].namestringAsset name
data.items[].urlstringVolcengine asset URL (typically 12-hour validity)
data.items[].assetTypestringAsset type: Image, Video, Audio
data.items[].groupIdstringAsset group ID
data.items[].statusstringVolcengine status: Processing, Active, Failed
data.items[].projectNamestringVolcengine project name
data.items[].createTimeintegerCreate time (Unix seconds)
data.items[].updateTimeintegerUpdate time (Unix seconds)
data.items[].errorobjectError info (when failed)
data.items[].error.codestringError code
data.items[].error.messagestringError description
data.items[].remarkstringPlatform remark
data.items[].asset_statusintegerPlatform asset status: 1 active, 2 disabled

Response Example​

{
"success": true,
"message": "",
"data": {
"totalCount": 1,
"pageNumber": 1,
"pageSize": 20,
"items": [
{
"id": "asset-a3c92f10",
"name": "Model Front Image",
"url": "https://example-signed-url.volces.com/xxx",
"assetType": "Image",
"groupId": "group-7f2b8d9c",
"status": "Active",
"projectName": "default_project",
"createTime": 1718000000,
"updateTime": 1718000300,
"remark": "External asset ID: ext-10001",
"asset_status": 1
}
]
}
}