List asset groups

Availability

This page documents the Modelflare asset-management route. Calls require a valid media API key, an available media channel, and the required permission.

Note

The gateway records provider asset IDs, status, and user ownership. The Castaly local library remains separate from the provider asset namespace.

Endpoint

POST https://modelflare.dev/volc/asset/ListAssetGroups

Authentication

Use a Modelflare API key:

bash

-H "Authorization: Bearer YOUR_MODELFLARE_API_KEY"

Send Idempotency-Key with create, update, and delete requests. Retrying the same key for the same user replays the saved response without repeating the mutation.

Request

List groups with optional name, ID, and group-type filters. Reads do not incur generation charges.

Field	Type	Required	Description	Example
model	string	Yes	Billing model. Defaults to volc-asset.	volc-asset
Filter.Name	string	No	Fuzzy name filter.	my-project
Filter.GroupIds	string[]	No	Exact filter by a list of group IDs.	["group-20260320141746-zsf6b"]
Filter.Id	string	No	Exact filter by one group ID.	group-20260320141746-zsf6b
Filter.GroupType	AIGC	LivenessFace	No	Filter by group type.
PageNumber	integer	No	Page number. Defaults to 1.	1
PageSize	integer	No	Items per page. Defaults to 10.	10

JSON example:

JSON

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

cURL example:

bash

curl --request POST https://modelflare.dev/volc/asset/ListAssetGroups \
  --header "Authorization: Bearer YOUR_MODELFLARE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "volc-asset",
  "Filter": {
    "Name": "my-project",
    "GroupIds": [
      "group-20260320141746-zsf6b"
    ],
    "GroupType": "AIGC"
  },
  "PageNumber": 1,
  "PageSize": 10
}'

Response

The request succeeded.

Field	Type	Required	Description	Example
Items[]	object[]	No	Asset groups with Id, Name, GroupType, and Status.	{ Id, Name, GroupType, Status }
Items[].Id / Name	string	No	Group identity and display name.	group-20260320141746-zsf6b / my-project-assets
Items[].GroupType / Status	string	No	Group type and current state.	AIGC / Active
PageNumber	integer	No	Returned page number.	1
PageSize	integer	No	Returned page size.	10
TotalCount	integer	No	Total matching groups.	1

Response example:

JSON

{
  "Items": [
    {
      "Id": "group-20260320141746-zsf6b",
      "Name": "my-project-assets",
      "GroupType": "AIGC",
      "Status": "Active"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1
}

Errors

Status	Meaning
400	The request is invalid.
401	The API key is missing or unauthorized.

Error body example (when returned):

JSON

{
  "error": {
    "code": "invalid_request",
    "message": "Request validation failed."
  }
}

Image, video, and audio creation are asynchronous. After receiving an asset ID, call GetAsset and use the asset://<ID> reference only when the status is Active.