CreateAsset

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic1.jpg",
  "AssetType": "Image",
  "Name": "tea-reference"
}

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_audio/r2v_tea_audio1.mp3",
  "AssetType": "Audio",
  "Name": "tea-music"
}

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_video/video_by_sd2.mp4",
  "AssetType": "Video",
  "Name": "tea-video"
}

{
  "ResponseMetadata": {
    "RequestId": "20261020080000ABCDEF",
    "Action": "CreateAsset",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "ap-southeast-1"
  },
  "Result": {
    "Id": "asset-20261020080000-abcde"
  }
}

{
  "ResponseMetadata": {
    "RequestId": "20261020080000ABCDEF",
    "Action": "CreateAsset",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "ap-southeast-1",
    "Error": {
      "Code": "InvalidParameter.TypeMismatch",
      "Message": "Expected audio, got image."
    }
  }
}

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic1.jpg",
  "AssetType": "Image",
  "Name": "tea-reference"
}

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_audio/r2v_tea_audio1.mp3",
  "AssetType": "Audio",
  "Name": "tea-music"
}

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_video/video_by_sd2.mp4",
  "AssetType": "Video",
  "Name": "tea-video"
}

{
  "ResponseMetadata": {
    "RequestId": "20261020080000ABCDEF",
    "Action": "CreateAsset",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "ap-southeast-1"
  },
  "Result": {
    "Id": "asset-20261020080000-abcde"
  }
}

{
  "ResponseMetadata": {
    "RequestId": "20261020080000ABCDEF",
    "Action": "CreateAsset",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "ap-southeast-1",
    "Error": {
      "Code": "InvalidParameter.TypeMismatch",
      "Message": "Expected audio, got image."
    }
  }
}

POST {BaseUrl}/?Action=CreateAsset&Version=2024-01-01
Content-Type: application/json

Requests must be signed with HMAC-SHA256. See Authentication and conventions.

Assets are imported from a URL. Local file upload, file://, Base64 and data: URIs are not supported. The URL must be directly downloadable by the server; leave enough validity time on signed URLs.
A returned asset ID means the import was accepted. The asset must finish processing: poll GetAsset until Status=Active before using it for generation.
Every call creates a new asset. Importing the same URL again returns a different asset ID.

Request parameters

string

required

ID of the asset group to import into. A real-person group only accepts photos of the verified person; otherwise the asset status becomes Failed with Error.Code FaceMismatch.

string

required

Public HTTP(S) URL of the file. The field name is all uppercase.

string

required

Asset type: Image, Audio or Video. Must match the actual file type, otherwise InvalidParameter.TypeMismatch is returned.

string

Asset name, up to 64 characters.

string

Pass default or omit.

Response parameters

string

Asset ID. Reference it in generation tasks as asset://<asset ID>.

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic1.jpg",
  "AssetType": "Image",
  "Name": "tea-reference"
}

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_audio/r2v_tea_audio1.mp3",
  "AssetType": "Audio",
  "Name": "tea-music"
}

{
  "GroupId": "group-20261020080000-abcde",
  "URL": "https://ark-project.tos-cn-beijing.volces.com/doc_video/video_by_sd2.mp4",
  "AssetType": "Video",
  "Name": "tea-video"
}

{
  "ResponseMetadata": {
    "RequestId": "20261020080000ABCDEF",
    "Action": "CreateAsset",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "ap-southeast-1"
  },
  "Result": {
    "Id": "asset-20261020080000-abcde"
  }
}

{
  "ResponseMetadata": {
    "RequestId": "20261020080000ABCDEF",
    "Action": "CreateAsset",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "ap-southeast-1",
    "Error": {
      "Code": "InvalidParameter.TypeMismatch",
      "Message": "Expected audio, got image."
    }
  }
}

Interface Guide

API Endpoints

Usage Examples

Request parameters

Response parameters

​Request parameters

​Response parameters

Request parameters

Response parameters