List One or All Avatars

Global Server

https://video.a2e.ai

POST

/api/v1/anchor/character_list

Return all the avatars that are uploaded by users and provided by the system.
Provide user_video_twin_id (returned as _id by /api/v1/userVideoTwin/startTraining) to query for one avatar. Leaveuser_video_twin_id empty to get records of all avatars.

Use the _id as the id for using "/api/v1/video/generate"

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

user_video_twin_id

string

optional

returned as _id by /api/v1/userVideoTwin/startTraining. The ID of the custom created avatar being trained. Leave this empty to get all avatars.

type

string

optional

Avatar Type (custom or default: whether it is uploaded by a user or provided by the system)

Example

{
  "user_video_twin_id": "660bc9da690879c4b5b20e82",
  "type": "custom"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://video.a2e.ai/api/v1/anchor/character_list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_video_twin_id": "660bc9da690879c4b5b20e82",
    "type": "custom"
}'

Responses

🟢200character_list

application/json

Body

code

integer

required

0 is OK

data

array [object {18}]

required

type

string

required

Avatar Type (custom or default: whether it is uploaded by a user or provided by the system)

_id

string

required

the ID to use video generation (/api/v1/video/generate)

createdAt

string

required

isExclusive

boolean

required

wl_model

string

deprecated

Lagacy

background_img

string

required

backgroud img of the avatar

background_color

string

required

backgroud color of the avatar.
background_img and background_color: the presence of either one is sufficient for image matting (or background removal).

base_video

string

required

the origin base video of the avatar. For video thumbnail retrieval, please refer to our FAQ: How to get video thumbnails？

people_img

string

required

the matting image of the avatar.When the field is empty, it means that the image cannot be matting.

lang

array[string]

required

width

integer

required

height

integer

required

user_photo_twin_id

string

required

user_photo_twin_image_id

string

required

user_video_twin_id

string

required

the ID for the query of this API (/api/v1/anchor/character_list)

video_cover

string

required

the video thumbnails get from base_video.

decode_img

string

deprecated

decode_img_icon

string

deprecated

Example

{
  "code": 0,
  "data": [
    {
      "type": "default",
      "_id": "66bb0ddb167f118c935f81b3",
      "createdAt": "2024-08-13T07:40:11.665Z",
      "isExclusive": false,
      "wl_model": "V393eea3fc92fb4d7526c923a262178dc1",
      "background_img": "",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/998546b1-34bc-4023-8f93-bae2fe433c5e.mp4",
      "people_img": "",
      "lang": [
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/1d9fa790-ab91-409e-9a20-b6915354d894.jpeg"
    },
    {
      "type": "default",
      "_id": "66bb0ccb167f118c935f7c00",
      "createdAt": "2024-08-13T07:35:39.991Z",
      "isExclusive": false,
      "wl_model": "V3fdfb70bfb4e8fc3be70bce09b78f23dc",
      "background_img": "",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/d1a5b2c0-3f99-4c21-8fa0-b4d7b2114463.mp4",
      "people_img": "",
      "lang": [
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "default",
      "_id": "66b0f622ed129340d7407fc7",
      "createdAt": "2024-08-05T15:56:18.558Z",
      "isExclusive": false,
      "wl_model": "V3649932a5fffa0078a3ceef560883acdc",
      "background_img": "",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/bd33872f-dab8-48c7-a0ee-1a1d217b73bc.mp4",
      "people_img": "",
      "lang": [
        "en-US",
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "default",
      "_id": "66a7318d8bb5e7e8ba30977d",
      "createdAt": "2024-07-29T06:07:09.679Z",
      "isExclusive": false,
      "wl_model": "V35e6a7d481d921fa4d1d463f396e24692",
      "background_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/ba0b050d-2971-43cf-b94d-c95a1deef0f7.jpg",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/738e2bcc-6af0-474d-ae25-cefddb900c71.mp4",
      "people_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/result_video/cafa657b-6b43-4251-ae45-ceb45eafa472._1_back_removal.png",
      "lang": [
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "default",
      "_id": "66a72a0b45ea38e8c0e22911",
      "createdAt": "2024-07-29T05:35:07.761Z",
      "isExclusive": false,
      "wl_model": "V35e1cf63b90631994266b0f204d3cf020",
      "background_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/efb3863d-cd81-4469-ac02-3c050ec9bcef.jpg",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/48022ecd-4d74-46dc-b2d1-416ebeb8c2cb.mp4",
      "people_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/result_video/dad4f10f-b358-4dff-8b08-4eb88b347a48._1_back_removal.png",
      "lang": [
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "default",
      "_id": "66a729fda8d07ee8f6dbb470",
      "createdAt": "2024-07-29T05:34:53.137Z",
      "isExclusive": false,
      "wl_model": "V3526474da125afb60452a17cae437d418",
      "background_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/c9126b01-3eb2-4f38-99be-de850fedfff7.jpg",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/bf39a7ba-9a29-4704-97c2-1c6bc1358f80.mp4",
      "people_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/result_video/f1b77801-e0ae-4cef-ae85-dd9144e22960._1_back_removal.png",
      "lang": [
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "default",
      "_id": "66a7178c06d240e8d82667e4",
      "createdAt": "2024-07-29T04:16:12.394Z",
      "isExclusive": false,
      "wl_model": "V3a564ec0a85a61f1265aafe3b1d53b58d",
      "background_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/9959a14e-ef4d-4833-9bc8-7e1f08c73396.jpg",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/bb54bcc6-ec54-4089-956f-666466fc2228.mp4",
      "people_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/result_video/bf0b9fa0-5849-4621-82b3-2deddebc5871._1_back_removal.png",
      "lang": [
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "default",
      "_id": "66a717142bdbabe8d27aff0c",
      "createdAt": "2024-07-29T04:14:12.983Z",
      "isExclusive": false,
      "wl_model": "V307795a67027eba6190c9f3085fc350c3",
      "background_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/5c246e95-57a3-46ff-8909-2ea11d80211f.jpg",
      "background_color": "",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/267a05eb-6230-43a0-9d51-1a76a97c7c38.mp4",
      "people_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/result_video/4010e3ac-8ce8-46e0-a738-46af3a27090c._1_back_removal.png",
      "lang": [
        "zh-CN"
      ],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "custom",
      "_id": "66b5de7641730b0416d114f7",
      "createdAt": "2024-08-09T09:16:38.470Z",
      "width": 0,
      "height": 0,
      "isExclusive": true,
      "wl_model": "V31d9925e35e06cfe206f37555e973ab32",
      "user_photo_twin_id": "",
      "user_photo_twin_image_id": "",
      "user_video_twin_id": "669a4a8a496a322f261fa87e",
      "background_img": "",
      "background_color": "rgba(129,120,83,1)",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/video_twin/fef459bf-e28a-46e7-a0e6-8fb42e7dbdd1.mp4",
      "people_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/video_custom_anchor_replace_background/9a0364e1a838d47f8df0618084658a45_2fad16181896a52e73461ea0a80b9124_matting.png",
      "lang": [],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    },
    {
      "type": "custom",
      "_id": "6699f005ba34c03ef24a533b",
      "createdAt": "2024-07-19T04:48:05.992Z",
      "width": 0,
      "height": 0,
      "isExclusive": true,
      "wl_model": "V31d9925e35e06cfe206f37555e973ab32",
      "user_photo_twin_id": "",
      "user_photo_twin_image_id": "",
      "user_video_twin_id": "6699ef909bcda63efe547651",
      "background_img": "",
      "background_color": "rgba(122,113,71,1)",
      "base_video": "https://d1tzkvq5ukphug.cloudfront.net/zhangcong/MODEL_PTH/A2E_BASE_VIDEOS/V31d9925e35e06cfe206f37555e973ab32.mp4",
      "people_img": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/video_custom_anchor_replace_background/9a0364e1a838d47f8df0618084658a45_7388b9c6fe8181f5247a8df2065f9a7a_matting.png",
      "lang": [],
      "video_cover": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/stable/reUpload/86f820b7-691e-4582-83e1-6cc92568db0b.jpeg"
    }
  ]
}

List of Result Videos

Obtain the Status of One Avatar Video Task