Skip to content

ark_asset_group_list

List private asset groups by fuzzy name and type, or read up to 20 by group_ids.

group_type ‘AIGC’ = virtual portraits, ‘LivenessFace’ = verified real people. Only groups owned by this account are visible. Requires AK/SK.

Requirement Value
Registration Requires BYTEPLUS_MODELARK_ACCESS_KEY and BYTEPLUS_MODELARK_SECRET_KEY.
Execution Foreground only
Required permission assets:read

This site lists the full configured capability surface, not the tools enabled on your particular server. Use model discovery and job discovery to check your connection. Credentials are server configuration, never tool arguments.

Ask your connected AI client to use ark_asset_group_list for the operation you want. The client constructs the arguments and handles tool calls. Review its proposed operation before approving anything billable. For a non-billable introduction, start with discovery without generation.

Call this tool directly. It is not a background-job target.

Match the input fields below and the full JSON Schema. See the worked examples for this capability and Background Execution for job/result handling.

The MCP arguments object wraps these fields as {"input": {...}}.

Field Type Required Description and constraints
group_ids array of string or null No Read these groups (1-20 IDs, any type) instead of listing. Exclusive with name, next_token, sort_order.; Default: null
group_type “AIGC”, “LivenessFace” No ‘AIGC’ (virtual portrait) or ‘LivenessFace’ (verified real person). Ignored with group_ids.; Default: “AIGC”
max_results integer No Page size (1-100). Ignored with group_ids.; minimum: 1; maximum: 100; Default: 20
name string or null No Fuzzy group-name filter.; Default: null
next_token string or null No next_token from the previous page.; Default: null
project_name string or null No ModelArk project name; defaults to BYTEPLUS_MODELARK_PROJECT_NAME. Assets only work within one project, so keep it consistent.; Default: null
sort_order “Asc”, “Desc” or null No Creation-time order; provider default when omitted.; Default: null
Field Type Required Description and constraints
errors array of AssetLookupError No group_ids that could not be read.
groups array of AssetGroup Yes Asset groups on this page.
next_token string or null No Pass as next_token for the next page; null on the last page.; Default: null

Field types named above refer to these shared definitions. Optional/null fields, enum choices and bounds are retained in the complete schemas below. Schema validation is followed by runtime capability and security checks.

AssetGroupListInput
Field Type Required Description and constraints
group_ids array of string or null No Read these groups (1-20 IDs, any type) instead of listing. Exclusive with name, next_token, sort_order.; Default: null
group_type “AIGC”, “LivenessFace” No ‘AIGC’ (virtual portrait) or ‘LivenessFace’ (verified real person). Ignored with group_ids.; Default: “AIGC”
max_results integer No Page size (1-100). Ignored with group_ids.; minimum: 1; maximum: 100; Default: 20
name string or null No Fuzzy group-name filter.; Default: null
next_token string or null No next_token from the previous page.; Default: null
project_name string or null No ModelArk project name; defaults to BYTEPLUS_MODELARK_PROJECT_NAME. Assets only work within one project, so keep it consistent.; Default: null
sort_order “Asc”, “Desc” or null No Creation-time order; provider default when omitted.; Default: null
Input schema, including the MCP wrapper
{
"$defs": {
"AssetGroupListInput": {
"description": "Input for ``ark_asset_group_list``.",
"properties": {
"group_ids": {
"anyOf": [
{
"items": {
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$",
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Read these groups (1-20 IDs, any type) instead of listing. Exclusive with name, next_token, sort_order."
},
"group_type": {
"default": "AIGC",
"description": "'AIGC' (virtual portrait) or 'LivenessFace' (verified real person). Ignored with group_ids.",
"enum": [
"AIGC",
"LivenessFace"
],
"type": "string"
},
"max_results": {
"default": 20,
"description": "Page size (1-100). Ignored with group_ids.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"name": {
"anyOf": [
{
"maxLength": 64,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Fuzzy group-name filter."
},
"next_token": {
"anyOf": [
{
"maxLength": 4096,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "next_token from the previous page."
},
"project_name": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "ModelArk project name; defaults to BYTEPLUS_MODELARK_PROJECT_NAME. Assets only work within one project, so keep it consistent."
},
"sort_order": {
"anyOf": [
{
"enum": [
"Asc",
"Desc"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Creation-time order; provider default when omitted."
}
},
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"input": {
"$ref": "#/$defs/AssetGroupListInput"
}
},
"required": [
"input"
],
"type": "object"
}
Output schema, including nested definitions
{
"$defs": {
"AssetGroup": {
"description": "One asset group: all assets of a single subject.",
"properties": {
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Creation time (ISO-8601, provider value).",
"title": "Created At"
},
"description": {
"default": "",
"description": "Free-text group description.",
"title": "Description",
"type": "string"
},
"group_id": {
"description": "Asset group ID (e.g. 'group-20260318033332-7vw4m').",
"title": "Group Id",
"type": "string"
},
"group_type": {
"default": "",
"description": "Group type: 'AIGC' (virtual portrait / non-real character, created by API) or 'LivenessFace' (verified real person, created by real-person verification).",
"title": "Group Type",
"type": "string"
},
"name": {
"default": "",
"description": "Group name (used for search; not seen by the model).",
"title": "Name",
"type": "string"
},
"project_name": {
"default": "",
"description": "ModelArk project that owns the group; assets only work in that project.",
"title": "Project Name",
"type": "string"
},
"updated_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Last update time (ISO-8601, provider value).",
"title": "Updated At"
}
},
"required": [
"group_id"
],
"title": "AssetGroup",
"type": "object"
},
"AssetLookupError": {
"description": "An asset or group ID that could not be read.",
"properties": {
"code": {
"description": "Provider error code (e.g. NotFound.Asset).",
"title": "Code",
"type": "string"
},
"id": {
"description": "The asset or group ID that failed.",
"title": "Id",
"type": "string"
},
"message": {
"description": "Human-readable reason.",
"title": "Message",
"type": "string"
}
},
"required": [
"id",
"code",
"message"
],
"title": "AssetLookupError",
"type": "object"
}
},
"description": "Output for ``ark_asset_group_list``.",
"properties": {
"errors": {
"description": "group_ids that could not be read.",
"items": {
"$ref": "#/$defs/AssetLookupError"
},
"title": "Errors",
"type": "array"
},
"groups": {
"description": "Asset groups on this page.",
"items": {
"$ref": "#/$defs/AssetGroup"
},
"title": "Groups",
"type": "array"
},
"next_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Pass as next_token for the next page; null on the last page.",
"title": "Next Token"
}
},
"required": [
"groups"
],
"title": "AssetGroupPage",
"type": "object"
}
  • Missing tool: check provider credentials and feature flags, then restart the connection.
  • Invalid arguments: keep the correct wrapper and follow current model limits from discovery. A valid schema alone does not prove the chosen model supports the combination.
  • A job completes with an error: inspect the original tool result, not only the outer job status. Never automatically resubmit potentially billable work.
  • Local output writes from jobs require server-configured OUTPUT_ROOTS; HTTP cannot write to a client’s local disk.

See configuration, background execution, and artifact delivery.