Skip to content

ark_asset_group_ensure

Return the single AIGC asset group named exactly subject, creating it if absent.

Fails with ambiguous_asset_group (listing IDs) when several groups share the name. Creation is serialized per server process; across servers, use a pre-created group ID. Real people use ark_asset_verification_start instead. Requires AK/SK.

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

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_ensure 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
description string or null No Used only when a new group is created.; 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
subject string Yes Exact subject name; reuses the single AIGC group with this name or creates it.; minLength: 1; maxLength: 64
Field Type Required Description and constraints
created boolean No True when this call created the group; false when it already existed.; Default: false
group AssetGroup Yes The asset group.

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.

AssetGroupEnsureInput
Field Type Required Description and constraints
description string or null No Used only when a new group is created.; 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
subject string Yes Exact subject name; reuses the single AIGC group with this name or creates it.; minLength: 1; maxLength: 64
Input schema, including the MCP wrapper
{
"$defs": {
"AssetGroupEnsureInput": {
"description": "Input for ``ark_asset_group_ensure``.",
"properties": {
"description": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Used only when a new group is created."
},
"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."
},
"subject": {
"description": "Exact subject name; reuses the single AIGC group with this name or creates it.",
"maxLength": 64,
"minLength": 1,
"type": "string"
}
},
"required": [
"subject"
],
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"input": {
"$ref": "#/$defs/AssetGroupEnsureInput"
}
},
"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"
}
},
"description": "Output for tools that return one asset group.",
"properties": {
"created": {
"default": false,
"description": "True when this call created the group; false when it already existed.",
"title": "Created",
"type": "boolean"
},
"group": {
"$ref": "#/$defs/AssetGroup",
"description": "The asset group."
}
},
"required": [
"group"
],
"title": "AssetGroupResult",
"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.