Generate Videos/Images
Get Avatar List
Get the avatar list
Start with the API
GET https://devapi.vidnoz.com/v2/avatar/list
Request Attributes
Parameter | Required | Type | Description |
---|---|---|---|
personal | false | bool | Is it a custom avatar: true = custom avatar; false = official avatar (default) |
limit | false | int | Number of items retrieved on the current page; default is 20. |
end_cursor | false | string | Pagination cursor; leave empty or omit to retrieve the first page. |
Example
Request Attributes
curl --request GET \
--url https://devapi.vidnoz.com/v2/avatar/list?personal=false \
--header "accept: application/json" \
--header "Authorization: Bearer $API_KEY" \
Response Attributes
Parameter | Type | Description |
---|---|---|
avatars | array | Avatar List |
avatars.id | string | Avatar ID |
avatars.name | string | Avatar Name |
avatars.gender | string | Gender of Avatar:male;female;unknown |
avatars.type | int | Avatar Type:1=Pro;2=Lite;3=Photo |
avatars.preview_image_url | string | Preview Image Link |
avatars.preview_audio_url | string | Preview Video Link |
Example
Response Attributes
{
"code": 200,
"message": "ok",
"data": {
"list": [
{
"id": "Rk1nN090NnZQWXlSZW5oSHJlSlhWdz09",
"name": "lite_off",
"gender": "male",
"type": 2,
"preview_image_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202407/66908a564cb41.webp?response-content-type=image%2Fwebp&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=d7578d08c4b31b0c73e9406eafb3ca3e5d3830268f4e1d9e1808d4c33e08e24c",
"preview_video_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202407/6697675ca7c9a.mp4?response-content-type=video%2Fmp4&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=ba1a079f93a1800cd0b8d8a3942511e0f3e224d13e283c7e824a8eb0a18c7245"
},
{
"id": "VXplRStKc0p2SDV2ZmhqM3BIVVE4UT09",
"name": "lite_ho",
"gender": "female",
"type": 2,
"preview_image_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202407/6690898595675.webp?response-content-type=image%2Fwebp&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=c52e6eea6cec5b716f8385ff579acb210724cfc7a169a54a5ef42e7d1a215be2",
"preview_video_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202407/6697677659073.mp4?response-content-type=video%2Fmp4&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=b62e980f0eb670b9affe1e5d224a55e076cac23303ac26a6d76cd7b4f1c2fc06"
},
{
"id": "b2xjN3l1T2NxVUZUYWhRWDE4ZHJsQT09",
"name": "lite_dst",
"gender": "male",
"type": 2,
"preview_image_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202407/669088916c399.webp?response-content-type=image%2Fwebp&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=c42428435835f5f930780b45f24c9fc9ba445312357b1ca55dac57acae5f18ca",
"preview_video_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202407/6697679cc7973.mp4?response-content-type=video%2Fmp4&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=f2992a8ed6c48ee98d2fc42d94d3d6ae765aa102dffdbd74ecb86b01cf1a3cbb"
},
{
"id": "a2NLazdNT1kwbG9ZcEpkTlJGVmlSdz09",
"name": "cdanna",
"gender": "female",
"type": 1,
"preview_image_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202405/663db8abbfd1f.webp?response-content-type=image%2Fwebp&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=d7dccfa6d6b2f069018efa5a644b79d194b33a2bb65709dba8cdec160106006e",
"preview_video_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202406/665d368f62457.mp4?response-content-type=video%2Fmp4&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T091830Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=6507cc4e02901df3173c35fe1d70b74ed61f0f3725416963c967a2e1d5da19d2"
},
{
"id": "SDNwZDEwTml0bE1yUXM1UkR1Nnhvdz09",
"name": "cdanna",
"gender": "female",
"type": 1,
"preview_image_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202405/663b23a543af3.webp?response-content-type=image%2Fwebp&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T104025Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=877e3addca6dae0f5cda622b166d72da38b73600d067d2741b2ddac49f4003b9",
"preview_video_url": "https://video-api-ai.s3.amazonaws.com/system/asset/202405/663b23b1cd175.webm?response-content-type=video%2Fwebm&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA43GAIFCW2JZIGP72%2F20250313%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250313T104025Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=271d6753e690e3197f7ac8b5c60afbfde58902fbdbcbdf9f93ac9c9e1f6cd07b"
}
],
"end_cursor": "324-1715151856"
}
}