# Alibaba Cloud Avatar API

> Alibaba Cloud Avatar API on Apizie: 31 endpoints (Cancel a task with the status "Waiting to Run" by using the TaskUuid generated when the task was submitted, When using the client rendering SDK, the SDK calls this interface for authentication, After authentication, the client-side rendering SDK calls this interface to start, You can call this operation to detach a device certificate when using the client rendering SDK, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-avatar/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-avatar`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/avatar
- Page: https://apizie.tech/api/cloud/aliyun-avatar
- OpenAPI: https://apizie.tech/api/cloud/aliyun-avatar/openapi.json

Alibaba Cloud OpenAPI for Avatar (avatar, version 2022-01-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Cancel a task with the status "Waiting to Run" by using the TaskUuid generated when the task was submitted
`POST https://apizie.tech/v1/cloud:aliyun-avatar/cancel-video-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. The TenantId obtained from the digitized virtual human Open Platform |
| App | string | yes | Application developer information, representing a business configuration (JSON-encoded) |
| TaskUuid | string | yes | Job UUID. The TaskUuid returned when you submit a corresponding video generation job |

### When using the client rendering SDK, the SDK calls this interface for authentication
`POST https://apizie.tech/v1/cloud:aliyun-avatar/client-auth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. The client SDK obtains this from the certificate |
| AppId | string | yes | The app ID. The client SDK obtains this from the certificate |
| License | string | yes | The client certificate |
| DeviceId | string | yes | The device ID |
| DeviceType | string | yes | The device type |
| DeviceInfo | string | no | The device details |

### After authentication, the client-side rendering SDK calls this interface to start
`POST https://apizie.tech/v1/cloud:aliyun-avatar/client-start` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. The client SDK obtains it through the certificate |
| AppId | string | yes | App ID. The client SDK obtains it through the certificate |

### You can call this operation to detach a device certificate when using the client rendering SDK
`POST https://apizie.tech/v1/cloud:aliyun-avatar/client-unbind-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | no | Tenant ID. Get this value from the digitized virtual human Open Platform |
| DeviceId | string | no | Device ID |

### This API shuts down timed start/stop instances for digitized virtual humans. These instances are managed on…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/close-timed-reset-operate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. Get the TenantId from the digitized virtual human Open Platform |
| InstanceId | string | yes | Instance ID. Get it from the Instance Management page of the digitized virtual human Open Platform |

### After a 2D custom digital human training job passes manual review, it enters a customer confirmation stage.…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/confirm-avatar2d-train` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Get TenantId from the developer information in the business configuration section of the Digitized Virtual Human Open… |
| Code | string | yes | The code of the digital human |
| Confirm | string | yes | ACCEPT: Confirms the job. DECLINE: Rejects the job |

### Submit a real-person video clip to generate a corresponding 2D digital human avatar. This API returns an…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/create2d-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | TenantId obtained from the digitized virtual human Open Platform |
| Name | string | yes | Avatar name |
| Description | string | no | Avatar description |
| Image | string | no | Thumbnail URL for the avatar. If not provided, the first frame of the video will be used as the thumbnail. If provided, it must match the… |
| Portrait | string | yes | Profile picture URL for the avatar. Requirements: 1:1 aspect ratio, PNG format, and smaller than 10 MB |
| Video | string | yes | URL of the original video footage. Requirements: Format: MOV, WebM, or MP4. Use WebM for transparent videos. Duration: 5–10 minutes… |
| Transparent | string | yes | Indicates whether the original video footage has a transparent background. true: Transparent format. Supports background replacement.… |
| Orientation | integer | yes | Video orientation: portrait or landscape. 1: Portrait 2: Landscape |
| Callback | string | no | Specifies whether to send a callback event when the 2D avatar generation task succeeds or fails. Default is false (no callback). For more… |

### Deletes a digital human asset by its avatar code
`POST https://apizie.tech/v1/cloud:aliyun-avatar/delete-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Obtain this ID from the Digitized Virtual Human Open Platform |
| Code | string | yes | The avatar code |

### Voice duplex decision API
`POST https://apizie.tech/v1/cloud:aliyun-avatar/duplex-decision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Obtain it from the digitized virtual human Open Platform |
| AppId | string | yes | The App ID. Find the developer information AppId in the lower-right corner of the business configuration product page |
| SessionId | string | yes | The session ID of the conversation |
| BizRequestId | string | yes | The business request ID, a unique ID for each request |
| DialogStatus | string | yes | The current call status. ROBOT_TALK: The digitized virtual human is speaking, and the user can interrupt. Send this status whenever the… |
| CallTime | integer | yes | Call timing: 0: Mid-sentence. 1: End of sentence |
| Text | string | yes | The text content of what the user said, as detected by ASR |
| DialogContext | string | no | Conversation context (JSON-encoded) |
| InterruptType | integer | no | Interrupt type. If not specified, the default is 0. 0: Algorithm semantic interrupt type. 1: Custom interrupt words. 2: Custom interrupt… |
| CustomKeywords | string | no | A list of custom interrupt words. The number of words cannot exceed 100, and each word cannot exceed 10 characters. This field is required… |

### Query the details of the corresponding video synthesis Job by using the TaskUuid generated upon Job…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/get-video-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The TenantId obtained from the digitized virtual human Open Platform. |
| App | string | yes | Represents a business configuration (JSON-encoded) |
| TaskUuid | string | yes | The job UUID, which is returned when you submit the corresponding Video generation job. |

### When you use the client-side rendering SDK, call this API with the license issued by the platform to obtain…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/license-auth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Obtain this ID from the developer information in the service configuration on the Digitized Virtual Human Open Platform |
| AppId | string | yes | The AppId. Obtain this ID from the developer information in the service configuration on the Digitized Virtual Human Open Platform |
| License | string | yes | The content of the license file. This file is generated after you attach the client package name. Download the license file for the… |

### Queries the details of an avatar asset by its code
`POST https://apizie.tech/v1/cloud:aliyun-avatar/query-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The TenantId obtained from the Digitized Virtual Human Open Platform |
| Code | string | yes | The code of the avatar. You can find this code in the asset center of the Open Platform |

### Query digitized virtual human assets under your account
`POST https://apizie.tech/v1/cloud:aliyun-avatar/query-avatar-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Obtain this value from the developer information section of the Digitized Virtual Human Open Platform |
| ModelType | string | yes | The model type. Valid values: 2d: 2D avatars 3d: 3D avatars |
| PageNo | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Query the list of running digital human instances. This API returns only running instances. Shutdown…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/query-running-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The TenantId obtained from the digitized virtual human Open Platform |
| App | string | yes | Represents a business configuration (JSON-encoded) |
| SessionId | string | no | Session SessionID, obtained from the return value of the "Start a digital human (StartInstance)" API. Passing this parameter queries the… |

### This operation queries the power status of a specific digital human instance that supports start and stop…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/query-timed-reset-operate-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Obtain the TenantId from the Digitized Virtual Human Open Platform |
| InstanceId | string | yes | The instance ID |

### Query a list of submitted video synthesis tasks, with support for paging. You can filter tasks by digitized…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/query-video-task-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. Get the TenantId from the Digitized Virtual Human Open Platform |
| App | string | yes | App information representing a business configuration (JSON-encoded) |
| TaskUuid | string | no | Task UUID returned when you submitted the corresponding video generation task |
| Title | string | no | Video task title to retrieve. The title must be fewer than 10 characters |
| Type | integer | no | Task type: 1: 3D digitized virtual human video synthesis. 3: 2D digitized virtual human video synthesis |
| Status | integer | no | Task business status. Expired and canceled tasks cannot be queried: 1: Waiting 2: Running 3: Success 4: Failed If not specified, all… |
| OrderById | string | no | ID sort order. Use asc for ascending order (latest data last) or desc for descending order (latest data first) |
| PageNo | integer | no | Page number for paging. Starts from 1 |
| PageSize | integer | no | Number of items per page for paging |

### When you use the client-side rendering SDK, the SDK calls this operation to retrieve rendering data for a 3D…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/render3d-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. The client SDK obtains this from its certificate |
| AppId | string | yes | App ID. The client SDK obtains this from its certificate |
| Code | string | yes | Avatar code |

### Send an instruction message to the server. The digital human executes the corresponding instruction and…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/send-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID, obtained from the digitized virtual human Open Platform |
| SessionId | string | yes | Session ID. Obtain it from the return value of the "Start a digital human" API |
| Code | string | yes | Instruction code: INTERRUPT: Interrupt the current digital human narration and stop the digital human from speaking. No content needs to… |
| Content | string | no | Instruction content, in map format. Different instructions require different parameter content. This parameter can be omitted for… |
| UniqueCode | string | yes | Unique code for the message request. Supports up to 64-bit values and must be unique. A UUID can be used |
| Feedback | string | no | Specifies whether to send a callback notification when the digital human executes this message. Default value: false. For more… |

### Send a piece of broadcast text to the server. The digital human performs TTS generation, facial expression…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/send-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| SessionId | string | no | Session ID. Obtain this value from the return value of the "Start a Digital Human" API |
| TenantId | integer | no | Tenant ID obtained from the Digitized Virtual Human Open Platform |
| TextRequest | string | no | Text to be spoken (JSON-encoded) |
| VAMLRequest | string | no | VAML protocol request object (JSON-encoded) |
| Feedback | string | no | Specifies whether to send a callback notification when the digital human delivers this message. The default value is false. For more… |
| StreamExtension | string | no | Stream extension object. Do not pass this object if streaming broadcast is not used. The user must split the text into segments (for… |

### Send a text message to the server. The digital human reads out the corresponding text and renders the video…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/send-text` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID, obtained from the digitized virtual human Open Platform |
| SessionId | string | yes | Session ID. Obtain it from the return value of the "Start a Digital Human" API |
| Text | string | yes | Content of the text to be broadcast. Currently supports plain text and Alibaba Cloud Intelligent Speech Synthesis SSML (Speech Synthesis… |
| Interrupt | string | no | Specifies whether this broadcast request interrupts the currently playing content. The default value is true |
| UniqueCode | string | yes | Unique code for the broadcast request. Supports up to 64-bit and must be unique. You can use a UUID |
| Feedback | string | no | Specifies whether to send a callback notification when the digital human broadcasts this message. The default value is false. For more… |
| StreamExtension | string | no | Extender object for streaming playback. If not using streaming playback, do not pass this object. The user must split the text into… |

### Send a VAML text message to the server. The digital human reads out the corresponding text and renders the…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/send-vaml` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID, obtained from the digitized virtual human Open Platform |
| SessionId | string | yes | Session ID. You can obtain it from the return value of the "Start a digital human" API |
| Vaml | string | yes | VAML protocol request. For details, see the official document… |

### Start an instance of a digital human video stream. By passing in specified parameters, you can start a…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/start-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | no | Tenant ID, obtained from the developer information of the corresponding business configuration in the digitized virtual human Open Platform |
| App | string | no | Represents a business configuration (JSON-encoded) |
| User | string | no | User information for starting this digital human (such as the Customer's own user information or device ID; if unavailable, a random… |
| Channel | string | no | Channel information for pushing the digital human streaming media to a specified Channel. Standard RTMP protocol is currently supported.… |
| CommandRequest | string | no | Digital human command execution request (JSON-encoded) |
| BizId | string | no | Business request ID, supporting up to 64 characters. You can use this field to ensure idempotency when starting a digital human instance.… |
| TextRequest | string | no | Configuration parameters related to the spoken content (JSON-encoded) |

### This operation powers on specified digital human timed reset instances. You can find these instances on the…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/start-timed-reset-operate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. Get this from the digitized virtual human Open Platform |
| InstanceId | string | yes | Instance ID. Get this from the Instance Management page in the digitized virtual human Open Platform |

### Shut down a digital human instance and stop stream ingest
`POST https://apizie.tech/v1/cloud:aliyun-avatar/stop-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | no | The TenantId obtained from the developer information in the business configuration of the digitized virtual human Open Platform |
| SessionId | string | no | Session SessionID. Obtain it from the return value of the "Start a digital human" API |

### Submit an offline task to generate a 2D digital human video from a WAV audio file. This operation returns a…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/submit-audio-to2-davatar-video-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. Get this value from the digitized virtual human Open Platform |
| App | string | yes | App information. Represents a business configuration (JSON-encoded) |
| Title | string | yes | Task title for the video synthesis. Maximum length: 32 characters |
| VideoInfo | string | no | Video configuration (JSON-encoded) |
| AvatarInfo | string | no | Digital human configuration (JSON-encoded) |
| AudioInfo | string | no | Audio configuration (JSON-encoded) |
| Url | string | yes | URL of the audio file. The audio must be less than 30 minutes long. It must have a 16 kHz sampling rate, one channel, and 16-bit sample… |
| Callback | string | no | Enable event callbacks for this video synthesis task. Default: false. Alibaba Cloud supports callbacks at task start and task completion.… |
| CallbackParams | string | no | Parameters to pass through with the callback. Must be a JSON string. Ignored when Callback is false |
| ExtParams | string | no | Additional parameters |

### Submits a task to generate a 3D digital human video from a WAV audio file. This operation immediately…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/submit-audio-to3-davatar-video-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Obtain this ID from the Digitized Virtual Human Open Platform |
| App | string | yes | The application information, which represents a business configuration (JSON-encoded) |
| Title | string | yes | The title of the video synthesis task. The title can be up to 32 characters long |
| VideoInfo | string | no | The video configuration (JSON-encoded) |
| AvatarInfo | string | no | The configuration of the digital human (JSON-encoded) |
| Url | string | yes | The URL of the audio file. The audio file must be less than 30 minutes in duration, have a sample rate of 16 kHz, be single-channel, and… |
| Callback | string | no | Specifies whether to receive event callbacks for the video synthesis task. The default value is \`false\`. The platform can send callbacks… |
| CallbackParams | string | no | The parameters that you want to pass through in the callback. This parameter must be a JSON string. This parameter is invalid if… |
| ExtParams | string | no | The extended parameters |
| AudioInfo | string | no | The audio configuration (JSON-encoded) |

### Submit a task to generate a video of a digitized virtual human
`POST https://apizie.tech/v1/cloud:aliyun-avatar/submit-avatar-video-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID. Obtain the TenantId from the digitized virtual human Open Platform |
| App | string | yes | App information, representing a business configuration (JSON-encoded) |
| Title | string | yes | The title of the submitted video synthesis task |
| VideoParams | string | yes | Related parameters required for the synthesized video |
| Callback | string | no | Whether this video synthesis task requires an event callback. The default is false, meaning no callback. The platform supports event… |
| CallbackParams | string | no | Parameters to pass through during the callback, in JSON string format. This parameter does not take effect when Callback is set to false |
| ExtParams | string | no | Extension parameters |

### Submit a job to generate a 2D digital human video offline based on a piece of text. This API immediately…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/submit-text-to2-davatar-video-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID, obtained from the Digitized Virtual Human Open Platform |
| App | string | yes | Developer application information, representing a business configuration (JSON-encoded) |
| Title | string | yes | The title of the submitted video synthesis job. The title can contain up to 64 characters |
| Text | string | yes | Input text for synthesis. Maximum length: 1000 characters. Supports SSML for specifying TTS pronunciation of polyphonic characters,… |
| VideoInfo | string | no | Video configuration (JSON-encoded) |
| AudioInfo | string | no | Audio-related configuration. If not provided, the default value configured in the asset will be used. (JSON-encoded) |
| AvatarInfo | string | no | Configuration related to the digital human appearance (JSON-encoded) |
| Callback | string | no | Specifies whether to enable management event callbacks for this video synthesis job. The default value is false, which means no callback.… |
| CallbackParams | string | no | Additional parameters to pass through during the callback, provided as a JSON-formatted string. This parameter takes effect only when… |
| ExtParams | string | no | Some extension parameters |

### Submit a job to offline generate a 3D digital human video based on a piece of text. This API immediately…
`POST https://apizie.tech/v1/cloud:aliyun-avatar/submit-text-to3-davatar-video-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | Tenant ID, obtained from the digitized virtual human Open Platform |
| App | string | yes | App information, representing a business configuration (JSON-encoded) |
| Title | string | yes | Title of the submitted video synthesis job. The title can contain up to 64 characters. |
| Text | string | yes | The text to synthesize. It can contain up to 1,000 characters. SSML is supported to specify TTS pronunciation for polyphonic characters,… |
| VideoInfo | string | no | Video format (JSON-encoded) |
| AvatarInfo | string | no | Configuration related to the digital human (JSON-encoded) |
| AudioInfo | string | no | Audio-related configuration. If not provided, the default value configured in the asset will be used. Some voice styles from Alibaba Cloud… |
| Callback | string | no | Specifies whether to enable management event callbacks for this video synthesis job. The default value is false, which disables callbacks.… |
| CallbackParams | string | no | Parameters to be passed through during callback, provided as a JSON-formatted string. This parameter takes effect only when callback=true. |
| ExtParams | string | no | Extended parameters. |

### Updates a 2D custom avatar. You cannot modify an avatar while it is being created
`POST https://apizie.tech/v1/cloud:aliyun-avatar/update2d-avatar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |
| TenantId | integer | yes | The tenant ID. Get this ID from the developer information section of your business configuration on the Digitized Virtual Human Open… |
| Code | string | yes | The avatar code |
| Name | string | no | The character name |
| Description | string | no | The character description |
| Image | string | no | The character thumbnail. If you do not provide a thumbnail, the first frame of the video is used as the thumbnail. If you provide a… |
| Portrait | string | no | The character's profile picture. If you do not provide a profile picture, the existing one is not updated. - Requirements: 1:1 aspect… |
| Video | string | no | The URL of the source video material. You can only update the video for roles that failed to be created. Requirements: Format: MOV, WebM,… |
| Transparent | string | no | Specifies whether the source video has a transparent background. true: The video has a transparent background. The background can be… |
| Orientation | integer | no | The orientation of the source video. 1: Portrait 2: Landscape |
| Callback | string | no | Specifies whether to receive event callbacks for the success or failure of this 2D avatar generation task. The default value is false,… |

### version
`POST https://apizie.tech/v1/cloud:aliyun-avatar/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://avatar.cn-zhangjiakou.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-avatar/cancel-video-task" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Avatar API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-avatar/cancel-video-task with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Avatar API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Avatar itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Avatar API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-avatar.

### What is the status of the Alibaba Cloud Avatar API?
Needs your own provider key (bring your own key)