'1.0', 'info' => ['style' => 'RPC', 'product' => 'avatar', 'version' => '2022-01-30'], 'directories' => [ [ 'children' => ['QueryRunningInstance'], 'type' => 'directory', 'title' => 'Digital human instances', ], [ 'children' => ['SendText', 'SendVaml', 'SendCommand', 'SendMessage'], 'type' => 'directory', 'title' => 'Messages', ], [ 'children' => ['SubmitAudioTo3DAvatarVideoTask', 'SubmitTextTo3DAvatarVideoTask', 'SubmitTextTo2DAvatarVideoTask', 'SubmitAudioTo2DAvatarVideoTask', 'SubmitAvatarVideoTask', 'GetVideoTaskInfo', 'CancelVideoTask', 'QueryVideoTaskInfo'], 'type' => 'directory', 'title' => 'Digital human video synthesis', ], [ 'children' => ['ConfirmAvatar2dTrain', 'Create2dAvatar', 'Update2dAvatar', 'QueryAvatarList', 'QueryAvatar', 'DeleteAvatar'], 'type' => 'directory', 'title' => 'Digital human avatar management', ], [ 'children' => ['ClientUnbindDevice', 'Render3dAvatar', 'ClientStart', 'ClientAuth'], 'type' => 'directory', 'title' => 'Client-side rendering', ], [ 'children' => ['StartTimedResetOperate', 'CloseTimedResetOperate', 'QueryTimedResetOperateStatus'], 'type' => 'directory', 'title' => 'Console management', ], [ 'children' => ['DuplexDecision', 'LicenseAuth', 'StartInstance', 'StopInstance'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CancelVideoTask' => [ 'summary' => 'Cancel a task with the status "Waiting to Run" by using the TaskUuid generated when the task was submitted.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarUCNFJ6'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. The TenantId obtained from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Application developer information, representing a business configuration'."\n", 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. Obtain the corresponding appId on the Developer Center > Instance Management page. [References](https://help.aliyun.com/document_detail/479093.html?spm=a2c4g.447644.0.0.406f66c95dI2Ee#6a48daa1ee899).', 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskUuid', 'in' => 'query', 'schema' => ['description' => 'Job UUID. The TaskUuid returned when you submit a corresponding video generation job.', 'type' => 'string', 'required' => true, 'example' => 'xxxx-xxxx-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx', 'title' => ''], 'Code' => ['title' => 'Id of the request', 'description' => 'Returned error code', 'type' => 'string', 'example' => '502'], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '这是一个错误', 'title' => ''], 'Success' => ['description' => 'Whether the operation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Returned data from the invocation', 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'Task UUID', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx', 'title' => ''], 'IsCancel' => ['description' => 'Whether the task is canceled'."\n" ."\n" .'- true: Canceled'."\n" .'- false: Not canceled', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'FailReason' => ['description' => 'Reason for cancellation failure', 'type' => 'string', 'example' => '这里是取消失败原因', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx\\",\\n \\"Code\\": \\"502\\",\\n \\"Message\\": \\"这是一个错误\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskUuid\\": \\"xxxx-xxxx-xxxx\\",\\n \\"IsCancel\\": true,\\n \\"FailReason\\": \\"这里是取消失败原因\\"\\n }\\n}","type":"json"}]', 'title' => 'Cancel Video Composition Job', 'description' => 'This API can only cancel tasks with the status "**Waiting to Run**." Tasks that are already running or have ended cannot be canceled.'."\n", 'changeSet' => [ ['createdAt' => '2025-02-26T09:31:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-08-18T11:19:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelVideoTask'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:CancelVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ClientAuth' => [ 'summary' => 'When using the client rendering SDK, the SDK calls this interface for authentication.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarPCE7WS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. The client SDK obtains this from the certificate.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'The app ID. The client SDK obtains this from the certificate.', 'type' => 'string', 'required' => true, 'example' => 'dsdsf1', 'title' => ''], ], [ 'name' => 'License', 'in' => 'query', 'schema' => ['description' => 'The client certificate.', 'type' => 'string', 'required' => true, 'example' => 'FqTyXFrIqbIGnb_oqIvszv1wffODnpCDNDvOc6xNXbAhak1AwsfrCo2cSrPFAhHEitOb9VEG', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => 'xxxxxx', 'title' => ''], ], [ 'name' => 'DeviceType', 'in' => 'query', 'schema' => [ 'description' => 'The device type.', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'largeScreen', 'title' => '', ], ], [ 'name' => 'DeviceInfo', 'in' => 'query', 'schema' => ['description' => 'The device details.', 'type' => 'string', 'example' => '{"xxxx":"xxxxxxxxxxx"}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无权限操作', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"无权限操作\\"\\n}","type":"json"}]', 'title' => 'Client SDK Authentication', 'changeSet' => [ ['createdAt' => '2025-02-26T09:31:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ClientAuth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ClientStart' => [ 'summary' => 'After authentication, the client-side rendering SDK calls this interface to start.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarXCV1DP'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. The client SDK obtains it through the certificate.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'App ID. The client SDK obtains it through the certificate.', 'type' => 'string', 'required' => true, 'example' => 'dsdsf1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX'], 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Error code', 'type' => 'string', 'example' => '10010002', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '这是一个错误', 'title' => ''], 'Data' => [ 'description' => 'Returned data', 'type' => 'object', 'properties' => [ 'ImToken' => ['description' => 'Token for the client SDK to connect to the driver.', 'type' => 'string', 'example' => 'xxxxxxxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"10010002\\",\\n \\"Message\\": \\"这是一个错误\\",\\n \\"Data\\": {\\n \\"ImToken\\": \\"xxxxxxxxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'Start the client SDK', 'changeSet' => [ ['createdAt' => '2025-02-26T09:31:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ClientStart', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ClientUnbindDevice' => [ 'summary' => 'You can call this operation to detach a device certificate when using the client rendering SDK.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarXCV1DP'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. Get this value from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9185', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => false, 'example' => 'dsdsf1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无权限操作', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"无权限操作\\"\\n}","type":"json"}]', 'title' => 'Device Certificate Detachment for Client-Side Rendering', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ClientUnbindDevice', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CloseTimedResetOperate' => [ 'summary' => 'This API shuts down timed start/stop instances for digitized virtual humans. These instances are managed on the Instance Management page of the digitized virtual human Open Platform. This operation is equivalent to clicking the Shutdown button on that page.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. Get the TenantId from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxx', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID. Get it from the Instance Management page of the digitized virtual human Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'avatar_operation_public_cn-7pp2****802'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX'], 'Code' => ['description' => 'Result code', 'type' => 'string', 'example' => '0', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'operation success.', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" ."\n" .'- false: The call failed.'."\n" ."\n" .'- true: The call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Response data', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'avatar_operation_public_cn-7pp2****802'."\n", 'title' => ''], 'TenantId' => ['description' => 'Tenant ID. Get the TenantId from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"operation success.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InstanceId\\": \\"avatar_operation_public_cn-7pp2****802\\\\n\\",\\n \\"TenantId\\": 0\\n }\\n}","type":"json"}]', 'title' => 'Shutdown API for Start/Stop Operation', 'description' => '**Before using this API, review the [billing methods and prices](https://help.aliyun.com/document_detail/457248.html#1e716e704bcf5) for the digitized virtual human timed start/stop product.**'."\n" ."\n" .'**This API shuts down only timed start/stop instances. It does not apply to non-timed start/stop instances. **A successful API call indicates that the system has received your shutdown request. The instance status then changes to \'shutting down\' as the system performs the shutdown. **The shutdown typically completes within 1 minute. **After calling this API, poll the [Timed Start/Stop Instance Status Query API](https://help.aliyun.com/document_detail/475509.html) to check the shutdown status. **Poll every 3 seconds. Do not poll more than once per second, or you might encounter rate limits.**'."\n" ."\n" .'>'."\n" ."\n" .'After calling the shutdown API, the instance becomes unavailable immediately, and billing stops. To use the instance again, wait for the shutdown to complete, then call the startup operation to restart it.'."\n" ."\n" .'>', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:CloseTimedResetOperate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseTimedResetOperate'], ], ], ], 'ConfirmAvatar2dTrain' => [ 'summary' => 'After a 2D custom digital human training job passes manual review, it enters a customer confirmation stage. Use this operation to confirm or reject the job. If you confirm the job, your account is charged, and the training begins. If you reject the job, the creation process fails. Note: This feature is disabled by default. By default, your account is charged, and training starts automatically after the digital human passes review. To enable this feature, contact us.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarTR0K4I'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Get TenantId from the developer information in the business configuration section of the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxx', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The code of the digital human.', 'type' => 'string', 'required' => true, 'example' => 'CH_2d_xxxxxx', 'title' => ''], ], [ 'name' => 'Confirm', 'in' => 'query', 'schema' => ['description' => '- ACCEPT: Confirms the job.'."\n" ."\n" .'- DECLINE: Rejects the job.', 'type' => 'string', 'required' => true, 'example' => 'ACCEPT', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'."\n"], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '这是一个错误'."\n", 'title' => ''], 'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\\\n\\",\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"这是一个错误\\\\n\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'Confirm 2D Custom Avatar Training', 'description' => '**Before using this operation, review the [billing methods](https://help.aliyun.com/document_detail/457248.html?spm=a2c4g.457231.0.0.315630dajR9fm3#46dd3c2026ey0) and [pricing](https://help.aliyun.com/document_detail/457231.html?spm=a2c4g.457248.0.0.293d30dapJ3Dz5) for 2D real-person digitized virtual human customization.**'."\n" ."\n" .'**This feature is disabled by default.** The system trains the 2D real-person digitized virtual human automatically. To enable this feature, contact Alibaba Cloud support. Call the [QueryAvatar](https://help.aliyun.com/document_detail/2384397.html?spm=a2c4g.457231.0.0.482130daNQ3Ocd) operation to check training progress. Or subscribe to [digital human platform callback events](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.2384397.0.0.3ca3783exaQjng) to monitor progress in real time.'."\n" ."\n" .'For instructions on shooting real-person video footage, [see the guidelines](https://aliavatar.yuque.com/org-wiki-aliavatar-fa7ng3/yxc45d/golwgxe41rs67uov).', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ConfirmAvatar2dTrain', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [], ], ], 'Create2dAvatar' => [ 'summary' => 'Submit a real-person video clip to generate a corresponding 2D digital human avatar. This API returns an avatar code immediately. You can later use this code to call APIs that query, update, or delete the avatar.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarTR0K4I'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'TenantId obtained from the digitized virtual human Open Platform', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Avatar name', 'type' => 'string', 'required' => true, 'example' => '博远', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Avatar description', 'type' => 'string', 'required' => false, 'example' => '朝气蓬勃，富有感染力，适用于播音、传媒广电、企业宣传等场景', 'title' => ''], ], [ 'name' => 'Image', 'in' => 'query', 'schema' => ['description' => 'Thumbnail URL for the avatar.'."\n" ."\n" .'- If not provided, the first frame of the video will be used as the thumbnail.'."\n" ."\n" .'- If provided, it must match the original video resolution, use PNG format, and be smaller than 10 MB.', 'type' => 'string', 'required' => false, 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], ], [ 'name' => 'Portrait', 'in' => 'query', 'schema' => ['description' => 'Profile picture URL for the avatar.'."\n" ."\n" .'- Requirements: 1:1 aspect ratio, PNG format, and smaller than 10 MB', 'type' => 'string', 'required' => true, 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], ], [ 'name' => 'Video', 'in' => 'query', 'schema' => ['description' => 'URL of the original video footage. Requirements:'."\n" ."\n" .'- Format: MOV, WebM, or MP4. Use WebM for transparent videos.'."\n" ."\n" .'- Duration: 5–10 minutes'."\n" ."\n" .'- Resolution: 1080p'."\n" ."\n" .'- Size: smaller than 10 GB', 'type' => 'string', 'required' => true, 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.mov?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], ], [ 'name' => 'Transparent', 'in' => 'query', 'schema' => [ 'description' => 'Indicates whether the original video footage has a transparent background.'."\n" ."\n" .'- true: Transparent format. Supports background replacement.'."\n" ."\n" .'- false: Opaque format. Does not support background replacement.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => '', ], ], [ 'name' => 'Orientation', 'in' => 'query', 'schema' => [ 'description' => 'Video orientation: portrait or landscape.'."\n" ."\n" .'- 1: Portrait'."\n" ."\n" .'- 2: Landscape', 'enumValueTitles' => [1 => '1', '2'], 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => '', ], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to send a callback event when the 2D avatar generation task succeeds or fails. Default is false (no callback). For more information, see [Digital human callback event notifications](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.447644.0.0.406f5876hRJTVU).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0A466686-8F3A-55A6-93D8-A0225DC965C0'."\n", 'title' => ''], 'Code' => ['description' => 'Error code', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '这个一次错误消息。', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Data' => [ 'description' => 'Response data', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Avatar code', 'type' => 'string', 'example' => 'CH_2d_xxxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A466686-8F3A-55A6-93D8-A0225DC965C0\\\\n\\",\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"这个一次错误消息。\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Code\\": \\"CH_2d_xxxxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'Submit a 2D Custom Avatar Creation Job', 'description' => '**Before using this API, make sure you fully understand the [billing method](https://help.aliyun.com/document_detail/457248.html?spm=a2c4g.457231.0.0.315630dajR9fm3#46dd3c2026ey0) and [pricing](https://help.aliyun.com/document_detail/457231.html?spm=a2c4g.457248.0.0.293d30dapJ3Dz5) for the 2D real-person avatar customization product.**'."\n" ."\n" .'This API initiates an asynchronous task. After submission, the system automatically trains the 2D digital human avatar in the background. You can check the training progress by calling the [Query digital human asset details](https://help.aliyun.com/document_detail/2384397.html?spm=a2c4g.457231.0.0.482130daNQ3Ocd) API or by subscribing to [digital human platform callback events](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.2384397.0.0.3ca3783exaQjng) to monitor progress in real time.'."\n" ."\n" .'For guidance on how to record your real-person video footage, [see the detailed instructions here](https://aliavatar.yuque.com/org-wiki-aliavatar-fa7ng3/yxc45d/golwgxe41rs67uov).', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:Create2dAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [], ], ], 'DeleteAvatar' => [ 'summary' => 'Deletes a digital human asset by its avatar code.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarM637C1'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Obtain this ID from the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The avatar code.', 'type' => 'string', 'required' => true, 'example' => 'CH_2d_xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '10050008', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '这是一个错误信息', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Code\\": \\"10050008\\",\\n \\"Message\\": \\"这是一个错误信息\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'Delete digital human asset ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:DeleteAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/{#AssetId}'], ], ], ], ], ], 'DuplexDecision' => [ 'summary' => 'Voice duplex decision API.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Obtain it from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxx', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'The App ID. Find the developer information AppId in the lower-right corner of the business configuration product page.', 'type' => 'string', 'required' => true, 'example' => '12131231', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'The session ID of the conversation.', 'type' => 'string', 'required' => true, 'example' => 'xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'BizRequestId', 'in' => 'query', 'schema' => ['description' => 'The business request ID, a unique ID for each request.', 'type' => 'string', 'required' => true, 'example' => 'xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'DialogStatus', 'in' => 'query', 'schema' => ['description' => 'The current call status.'."\n" ."\n" .'1. ROBOT\\_TALK: The digitized virtual human is speaking, and the user can interrupt. Send this status whenever the digitized virtual human is speaking.'."\n" ."\n" .'2. USER\\_TALK: The digitized virtual human is not speaking, and the user is speaking. The robot can take over.', 'type' => 'string', 'required' => true, 'example' => 'ROBOT_TALK', 'title' => ''], ], [ 'name' => 'CallTime', 'in' => 'query', 'schema' => ['description' => 'Call timing:'."\n" ."\n" .'1. 0: Mid-sentence.'."\n" ."\n" .'2. 1: End of sentence.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The text content of what the user said, as detected by ASR.', 'type' => 'string', 'required' => true, 'example' => '你好', 'title' => ''], ], [ 'name' => 'DialogContext', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Conversation context.', 'type' => 'object', 'properties' => [ 'CurUtteranceIdx' => ['description' => 'The current conversation turn.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'Histories' => [ 'description' => 'Conversation history (can include the last 20 turns).', 'type' => 'array', 'items' => [ 'description' => 'Conversation history object.', 'type' => 'object', 'properties' => [ 'User' => ['description' => 'What the user said.', 'type' => 'string', 'required' => false, 'example' => '你好', 'title' => ''], 'Robot' => ['description' => 'The Q\\&A pair result replied by the digitized virtual human.', 'type' => 'string', 'required' => false, 'example' => '你好啊', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'InterruptType', 'in' => 'query', 'schema' => ['description' => 'Interrupt type. If not specified, the default is 0.'."\n" ."\n" .'1. 0: Algorithm semantic interrupt type.'."\n" ."\n" .'2. 1: Custom interrupt words.'."\n" ."\n" .'3. 2: Custom interrupt words + algorithm semantic interrupt.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'CustomKeywords', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of custom interrupt words. The number of words cannot exceed 100, and each word cannot exceed 10 characters. This field is required when InterruptType is 1.', 'type' => 'array', 'items' => ['description' => 'Custom interrupt word.', 'type' => 'string', 'required' => false, 'example' => '闭嘴', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The return code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'ActionType' => ['description' => 'The behavior category determined by the algorithm. Options are as follows:'."\n" .'INTERRUPT: Interrupt.'."\n" .'NO\\_ACTION: No action behavior.'."\n" .'UNDERTAKE: Take over.', 'type' => 'string', 'example' => 'UNDERTAKE', 'title' => ''], 'OutputText' => ['description' => 'The output takeover text.', 'type' => 'string', 'example' => '嗯', 'title' => ''], 'GrabType' => ['description' => 'After interrupting the digitized virtual human\'s speech, indicates whether the current ASR text needs to request a Q\\&A pair.'."\n" ."\n" .'- GRAB: Trigger a Q\\&A pair.'."\n" ."\n" .'- NO\\_GRAB: Do not trigger a Q\\&A pair.', 'type' => 'string', 'example' => 'GRAB', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"ActionType\\": \\"UNDERTAKE\\",\\n \\"OutputText\\": \\"嗯\\",\\n \\"GrabType\\": \\"GRAB\\"\\n },\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\"\\n}","type":"json"}]', 'title' => 'Voice Duplex Decision', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DuplexDecision'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:DuplexDecision', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetVideoTaskInfo' => [ 'summary' => 'Query the details of the corresponding video synthesis Job by using the TaskUuid generated upon Job submission. This API supports querying details for both 3D digital human and 2D digital human video synthesis Jobs. ', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarUCNFJ6'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The TenantId obtained from the digitized virtual human Open Platform. '."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Represents a business configuration '."\n", 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. You can obtain the corresponding appId on the Developer Center > Instance Management page. [References](https://help.aliyun.com/document_detail/479093.html?spm=a2c4g.447644.0.0.406f66c95dI2Ee#6a48daa1ee899). ', 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskUuid', 'in' => 'query', 'schema' => ['description' => 'The job UUID, which is returned when you submit the corresponding Video generation job. ', 'type' => 'string', 'required' => true, 'example' => 'xxxx-xxxx-xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => 'xxx-xxx-xxx-xx', 'title' => ''], 'Code' => ['description' => 'Error code ', 'type' => 'string', 'example' => '502', 'title' => ''], 'Message' => ['description' => 'Error message ', 'type' => 'string', 'example' => '这是一个错误', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API invocation succeeded. '."\n" .'- false: Failed to invoke. '."\n" .'- true: Succeeded. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Result data returned by the API invocation ', 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'Job UUID ', 'type' => 'string', 'example' => 'xxxx-xxx-xx-xx', 'title' => ''], 'Type' => ['description' => 'Task Type: '."\n" .'- 1: 3D digital human video synthesis '."\n" .'- 3: 2D digital human video synthesis ', 'type' => 'string', 'example' => '1', 'title' => ''], 'Status' => ['description' => 'Task Status: '."\n" .'- 1: Waiting to execute '."\n" .'- 2: Executing '."\n" .'- 3: Succeeded '."\n" .'- 4: Failed '."\n" .'- 5: Canceled '."\n" .'- 6: Expired ', 'type' => 'string', 'example' => '1', 'title' => ''], 'Process' => ['description' => 'Job execution progress. Currently not supported. ', 'type' => 'string', 'example' => '99', 'title' => ''], 'TaskResult' => [ 'description' => 'Task Result ', 'type' => 'object', 'properties' => [ 'VideoUrl' => ['description' => 'Video URL '."\n" .'>The validity period is 7 days. Download and save it as soon as possible. The URL will expire after this period. ', 'type' => 'string', 'example' => 'xxx/xxxx/xx.mp4', 'title' => ''], 'SubtitlesUrl' => ['description' => 'Caption URL '."\n" .'>The validity period is 7 days. Download and save it as soon as possible. The URL will expire after this period. ', 'type' => 'string', 'example' => 'xxx/xxx/xxx.ass', 'title' => ''], 'WordSubtitlesUrl' => ['description' => '字粒度的时间戳文件，特定任务支持', 'type' => 'string', 'example' => 'xxx/xxx/xxx.ass', 'title' => ''], 'FailReason' => ['description' => 'Reason for failure ', 'type' => 'string', 'example' => '这是一个失败原因', 'title' => ''], 'FailCode' => ['description' => 'Error code for failure ', 'type' => 'string', 'example' => '20002', 'title' => ''], 'VideoDuration' => ['description' => 'Duration of the generated video, in milliseconds ', 'type' => 'integer', 'format' => 'int32', 'example' => '60992', 'title' => ''], 'AlphaUrl' => ['description' => 'Mask video file corresponding to the MP4 ', 'type' => 'string', 'example' => 'xxx/xxx/xxx-alpha.mp4', 'title' => ''], 'PreviewPic' => ['description' => 'Preview image of the first frame of the video ', 'type' => 'string', 'example' => 'xxxxx.png', 'title' => ''], 'AttachmentUrl' => ['description' => 'Video attachment URL, supported for specific Jobs ', 'type' => 'string', 'example' => 'xxx.ini', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx-xx\\",\\n \\"Code\\": \\"502\\",\\n \\"Message\\": \\"这是一个错误\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskUuid\\": \\"xxxx-xxx-xx-xx\\",\\n \\"Type\\": \\"1\\",\\n \\"Status\\": \\"1\\",\\n \\"Process\\": \\"99\\",\\n \\"TaskResult\\": {\\n \\"VideoUrl\\": \\"xxx/xxxx/xx.mp4\\",\\n \\"SubtitlesUrl\\": \\"xxx/xxx/xxx.ass\\",\\n \\"WordSubtitlesUrl\\": \\"xxx/xxx/xxx.ass\\",\\n \\"FailReason\\": \\"这是一个失败原因\\",\\n \\"FailCode\\": \\"20002\\",\\n \\"VideoDuration\\": 60992,\\n \\"AlphaUrl\\": \\"xxx/xxx/xxx-alpha.mp4\\",\\n \\"PreviewPic\\": \\"xxxxx.png\\",\\n \\"AttachmentUrl\\": \\"xxx.ini\\"\\n }\\n }\\n}","type":"json"}]', 'title' => 'Query details of a video synthesis job ', 'description' => 'After successfully submitting a video synthesis Job, you can use the obtained TaskUuid to query the Job status via this API. Since video synthesis Jobs run offline, the running time varies. Therefore, the caller should periodically invoke this API to check the Job status until it reaches a final state (either Succeeded or failed). For Succeeded Jobs, the API returns synthesis details, including download URLs for the Video and caption. For failed Jobs, the API returns the failure reason. ', 'changeSet' => [ ['createdAt' => '2023-10-24T02:33:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-28T07:38:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-01T09:10:38.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-07T01:42:23.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-08T02:35:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-12-22T06:04:35.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-30T08:01:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-08-18T11:19:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVideoTaskInfo'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:GetVideoTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'LicenseAuth' => [ 'summary' => 'When you use the client-side rendering SDK, call this API with the license issued by the platform to obtain the authentication token required for SDK integration.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarPCE7WS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Obtain this ID from the developer information in the service configuration on the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'The AppId. Obtain this ID from the developer information in the service configuration on the Digitized Virtual Human Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'dsdsf1', 'title' => ''], ], [ 'name' => 'License', 'in' => 'query', 'schema' => ['description' => 'The content of the license file. This file is generated after you attach the client package name. Download the license file for the instance from its configuration.', 'type' => 'string', 'required' => true, 'example' => 'FqTyXFrIqbIGnb_oqIvszv1wffODnpCDNDvOc6xNXbAhak1AwsfrCo2cSrPFAhHEitOb9VEG', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'."\n"], 'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'operation success.'."\n", 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Token' => ['description' => 'The authentication token required for client-side rendering SDK integration.', 'type' => 'string', 'example' => 'vHOgG+IbVrm0QXTzVB/O4GJJLEAWr67gl7NGWowHjioMKIh2yc9PNu21S7t8mjuVo3Z', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\\\n\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"operation success.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Token\\": \\"vHOgG+IbVrm0QXTzVB/O4GJJLEAWr67gl7NGWowHjioMKIh2yc9PNu21S7t8mjuVo3Z\\"\\n }\\n}","type":"json"}]', 'title' => 'Client License Authentication', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:LicenseAuth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LicenseAuth'], ], ], ], 'QueryAvatar' => [ 'summary' => 'Queries the details of an avatar asset by its code.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The TenantId obtained from the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The code of the avatar. You can find this code in the asset center of the Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'CH_2d_xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX'], 'Code' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => '10050008', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '超过可同时生成的视频数上限', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The data returned by the call.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the avatar.', 'type' => 'string', 'example' => '博远', 'title' => ''], 'Description' => ['description' => 'The description of the avatar.', 'type' => 'string', 'example' => '朝气蓬勃，富有感染力，适用于播音、传媒广电、企业宣传等场景', 'title' => ''], 'Portrait' => ['description' => 'The profile picture of the avatar.', 'type' => 'string', 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], 'Image' => ['description' => 'The thumbnail of the avatar.', 'type' => 'string', 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], 'AllLocateImages' => ['description' => 'For 3D avatars, this parameter provides thumbnails from all resolutions, camera positions, and angles. It is for customers who build their own Software as a Service (SaaS) platforms using the Platform as a Service (PaaS) APIs of the digital human platform. The value is in JSON format.', 'type' => 'object', 'example' => '{}', 'title' => ''], 'SupportedResolutions' => [ 'description' => 'The supported resolutions.', 'type' => 'object', 'properties' => [ 'Offline' => [ 'description' => 'The resolutions for offline scenarios.', 'type' => 'array', 'items' => [ 'description' => 'The resolution.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'The width in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], 'Height' => ['description' => 'The height in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], 'Desc' => ['description' => 'The description of the resolution.', 'type' => 'string', 'example' => '1080P竖向，分辨率1080*1920'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Online' => [ 'description' => 'The resolutions for real-time scenarios.', 'type' => 'array', 'items' => [ 'description' => 'The resolution.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'The width in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], 'Height' => ['description' => 'The height in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], 'Desc' => ['description' => 'The description of the resolution.', 'type' => 'string', 'example' => '1080P竖向，分辨率1080*1920', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'ModelType' => ['description' => 'The model type. Valid values:'."\n" ."\n" .'- 2d: queries only 2D avatars.'."\n" ."\n" .'- 3d: queries only 3D avatars.', 'type' => 'string', 'example' => '2d', 'title' => ''], 'AvatarType' => ['description' => 'The avatar type. Valid values:'."\n" ."\n" .'- 0: official avatar.'."\n" ."\n" .'- 1: custom avatar.', 'type' => 'string', 'example' => '0', 'title' => ''], 'MakeStatus' => ['description' => 'The creation status of the 2D custom avatar. This parameter applies only to queries for 2D avatars. Valid values:'."\n" ."\n" .'- 1: Creating'."\n" ."\n" .'- 2: Creation failed'."\n" ."\n" .'- 3: Creation successful', 'type' => 'string', 'example' => '2', 'title' => ''], 'MakeFailReason' => ['description' => 'The reason why the creation of the 2D custom avatar failed. This parameter applies only to queries for 2D avatars.', 'type' => 'string', 'example' => '当前视频时长:6(s)，最小支持180(s)'."\n", 'title' => ''], 'MakeStage' => ['description' => 'The creation stage of the 2D custom avatar. This parameter applies only to queries for 2D avatars. Valid values:'."\n" ."\n" .'- 1: System check'."\n" ."\n" .'- 2: Manual review'."\n" ."\n" .'- 3: Training'."\n" ."\n" .'- 4: Creation successful', 'type' => 'string', 'example' => '1', 'title' => ''], 'Preview' => ['description' => 'The preview video of the 2D avatar.', 'type' => 'string', 'example' => 'https://xxx/xx/preview.webm', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX\\",\\n \\"Code\\": \\"10050008\\",\\n \\"Message\\": \\"超过可同时生成的视频数上限\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Name\\": \\"博远\\",\\n \\"Description\\": \\"朝气蓬勃，富有感染力，适用于播音、传媒广电、企业宣传等场景\\",\\n \\"Portrait\\": \\"https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"Image\\": \\"https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"AllLocateImages\\": {},\\n \\"SupportedResolutions\\": {\\n \\"Offline\\": [\\n {\\n \\"Width\\": 1080,\\n \\"Height\\": 1920,\\n \\"Desc\\": \\"1080P竖向，分辨率1080*1920\\\\n\\"\\n }\\n ],\\n \\"Online\\": [\\n {\\n \\"Width\\": 1080,\\n \\"Height\\": 1920,\\n \\"Desc\\": \\"1080P竖向，分辨率1080*1920\\"\\n }\\n ]\\n },\\n \\"ModelType\\": \\"2d\\",\\n \\"AvatarType\\": \\"0\\",\\n \\"MakeStatus\\": \\"2\\",\\n \\"MakeFailReason\\": \\"当前视频时长:6(s)，最小支持180(s)\\\\n\\",\\n \\"MakeStage\\": \\"1\\",\\n \\"Preview\\": \\"https://xxx/xx/preview.webm\\"\\n }\\n}","type":"json"}]', 'title' => 'Query details of a digital human asset ', 'changeSet' => [ ['createdAt' => '2024-02-26T06:54:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-28T02:13:32.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-28T03:34:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAvatar'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:QueryAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/{#AssetId}'], ], ], ], ], ], 'QueryAvatarList' => [ 'summary' => 'Query digitized virtual human assets under your account.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Obtain this value from the developer information section of the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'ModelType', 'in' => 'query', 'schema' => ['description' => 'The model type. Valid values:'."\n" ."\n" .'- 2d: 2D avatars'."\n" ."\n" .'- 3d: 3D avatars', 'type' => 'string', 'required' => true, 'example' => '2d', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '10050008', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '这个一个错误消息。', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'PageNo' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'The list of avatars.', 'type' => 'array', 'items' => [ 'description' => 'The avatar object.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The avatar code.', 'type' => 'string', 'example' => 'CH_2d_37AsLhUrBxacjHP0', 'title' => ''], 'Name' => ['description' => 'The avatar name.', 'type' => 'string', 'example' => '博远', 'title' => ''], 'Image' => ['description' => 'The thumbnail of the avatar.', 'type' => 'string', 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], 'Portrait' => ['description' => 'The user\'s profile picture.', 'type' => 'string', 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], 'Description' => ['description' => 'The avatar description.', 'type' => 'string', 'example' => '朝气蓬勃，富有感染力，适用于播音、传媒广电、企业宣传等场景', 'title' => ''], 'AvatarType' => ['description' => 'The avatar type. Valid values:'."\n" ."\n" .'- 0: official avatar'."\n" ."\n" .'- 1: custom avatar', 'type' => 'string', 'example' => '0', 'title' => ''], 'ModelType' => ['description' => 'The model type. Valid values:'."\n" ."\n" .'- 2d: 2D avatar'."\n" ."\n" .'- 3d: 3D avatar', 'type' => 'string', 'example' => '2d', 'title' => ''], 'SupportedResolutions' => [ 'description' => 'The supported resolutions.', 'type' => 'object', 'properties' => [ 'Offline' => [ 'description' => 'The resolutions for offline scenarios.', 'type' => 'array', 'items' => [ 'description' => 'The resolution.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'The width in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], 'Height' => ['description' => 'The height in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], 'Desc' => ['description' => 'The description of the resolution.', 'type' => 'string', 'example' => '1080P竖向，分辨率1080*1920', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Online' => [ 'description' => 'The resolutions for real-time scenarios.', 'type' => 'array', 'items' => [ 'description' => 'The resolution.', 'type' => 'object', 'properties' => [ 'Width' => ['description' => 'The width in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], 'Height' => ['description' => 'The height in pixels (px).', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], 'Desc' => ['description' => 'The description of the resolution.', 'type' => 'string', 'example' => '1080P竖向，分辨率1080*1920', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MakeStatus' => ['description' => 'The creation status of a custom 2D avatar. This parameter applies only to 2D avatars. Valid values:'."\n" ."\n" .'- 1: Creating'."\n" ."\n" .'- 2: Creation failed'."\n" ."\n" .'- 3: Creation succeeded', 'type' => 'string', 'example' => '2', 'title' => ''], 'MakeFailReason' => ['description' => 'The reason why the creation of the custom 2D avatar failed. This parameter applies only to 2D avatars.', 'type' => 'string', 'example' => '当前视频时长:6(s)，最小支持180(s)', 'title' => ''], 'MakeStage' => ['description' => 'The creation stage of a custom 2D avatar. This parameter applies only to 2D avatars. Valid values:'."\n" ."\n" .'- 1: System check'."\n" ."\n" .'- 2: Manual review'."\n" ."\n" .'- 3: Training'."\n" ."\n" .'- 4: Creation succeeded', 'type' => 'string', 'example' => '1', 'title' => ''], 'Preview' => ['description' => 'The URL of the preview video for a 2D avatar.', 'type' => 'string', 'example' => 'https://xxx/xx/preview.webm'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Code\\": \\"10050008\\",\\n \\"Message\\": \\"这个一个错误消息。\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TotalCount\\": 4,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalPage\\": 1,\\n \\"List\\": [\\n {\\n \\"Code\\": \\"CH_2d_37AsLhUrBxacjHP0\\",\\n \\"Name\\": \\"博远\\",\\n \\"Image\\": \\"https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"Portrait\\": \\"https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"Description\\": \\"朝气蓬勃，富有感染力，适用于播音、传媒广电、企业宣传等场景\\",\\n \\"AvatarType\\": \\"0\\",\\n \\"ModelType\\": \\"2d\\",\\n \\"SupportedResolutions\\": {\\n \\"Offline\\": [\\n {\\n \\"Width\\": 1080,\\n \\"Height\\": 1920,\\n \\"Desc\\": \\"1080P竖向，分辨率1080*1920\\"\\n }\\n ],\\n \\"Online\\": [\\n {\\n \\"Width\\": 1080,\\n \\"Height\\": 1920,\\n \\"Desc\\": \\"1080P竖向，分辨率1080*1920\\"\\n }\\n ]\\n },\\n \\"MakeStatus\\": \\"2\\",\\n \\"MakeFailReason\\": \\"当前视频时长:6(s)，最小支持180(s)\\",\\n \\"MakeStage\\": \\"1\\",\\n \\"Preview\\": \\"https://xxx/xx/preview.webm\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Query digital human asset list ', 'changeSet' => [ ['createdAt' => '2024-02-26T06:54:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-28T02:13:32.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-28T03:34:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAvatarList'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'avatar:QueryAvatarList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar:*:{#accountId}:asset/*'], ], ], ], ], ], 'QueryRunningInstance' => [ 'summary' => 'Query the list of running digital human instances. This API returns only running instances. Shutdown instances are not returned. Up to 100 entries are returned, sorted in reverse chronological order by start time. Additionally, you can query the running status of an instance with a specific sessionId by providing the sessionId parameter. If the instance is running, it will be returned; otherwise, no information will be returned if the instance is not running or does not exist.'."\n", 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The TenantId obtained from the digitized virtual human Open Platform '."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Represents a business configuration ', 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. You can find the Developer AppId in the developer information section at the bottom right corner of the product page. ', 'type' => 'string', 'required' => true, 'example' => 'ALIPUB5748B17121450', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'Session SessionID, obtained from the return value of the "Start a digital human (StartInstance)" API. '."\n" .'* Passing this parameter queries the running status of the instance corresponding to the SessionID. '."\n" .'* Not passing this parameter queries the running status of all instances. ', 'type' => 'string', 'required' => false, 'example' => '76898bd3b90b4a65b1c078d8824a2e9c', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID'."\n", 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'."\n", 'title' => ''], 'Code' => ['title' => 'Id of the request', 'description' => 'Return result code '."\n", 'type' => 'string', 'example' => '0'], 'Message' => ['description' => 'Return message'."\n", 'type' => 'string', 'example' => 'operation success.', 'title' => ''], 'Data' => [ 'description' => 'Return Result'."\n", 'type' => 'array', 'items' => [ 'description' => 'Collection of returned running instances'."\n", 'type' => 'object', 'properties' => [ 'SessionId' => ['description' => 'Session ID ', 'type' => 'string', 'example' => '4f63f9e9788449f9adc88d9438c8dec3', 'title' => ''], 'Channel' => [ 'description' => 'Channel information (same as the Channel information returned by the "Start a Digital Human (StartInstance)" API)'."\n", 'type' => 'object', 'properties' => [ 'ChannelId' => ['description' => 'Channel ID ', 'type' => 'string', 'example' => '108293819', 'title' => ''], 'Token' => ['description' => 'Token. ', 'type' => 'string', 'example' => 'e59f61b2482b4d0562ab542da3f824f7', 'title' => ''], 'Type' => ['description' => 'Channel type ', 'type' => 'string', 'example' => '6', 'title' => ''], 'ExpiredTime' => ['description' => 'Channel expiration time ', 'type' => 'string', 'example' => '2022-01-04T16:00Z', 'title' => ''], 'Nonce' => ['description' => 'A random string generated by the server.', 'type' => 'string', 'example' => 'CK-9b5c335b9ae75879441ee7b363886418', 'title' => ''], 'UserId' => ['description' => 'User ID generated by audio and video RTC. ', 'type' => 'string', 'example' => 'userId', 'title' => ''], 'AppId' => ['description' => 'Application ID used for RTC. ', 'type' => 'string', 'example' => 'ONEX7E28C7C221854', 'title' => ''], 'UserInfoInChannel' => ['description' => 'Information required for RTC on public cloud audio and video services. ', 'type' => 'string', 'example' => '公有云音视频RTC需要的信息', 'title' => ''], 'Gslb' => [ 'description' => 'Channel settings. ', 'type' => 'array', 'items' => ['description' => 'Channel settings. ', 'type' => 'string', 'example' => 'djfls', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'User' => [ 'description' => 'User information passed in the "Start a Digital Human (StartInstance)" API. The corresponding User object is returned here.'."\n", 'type' => 'object', 'properties' => [ 'UserId' => ['description' => 'User identity ID (User.UserId passed in the Start a Digital Human API)'."\n", 'type' => 'string', 'example' => '23423', 'title' => ''], 'UserName' => ['description' => 'Username (User.UserName passed in the Start a Digital Human API)'."\n", 'type' => 'string', 'example' => '测试用户', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Token' => ['description' => 'Authentication token required for integration with interactive digital humans. For details, refer to the interactive digital human integration document.', 'type' => 'string', 'example' => '879441ee7b363886418', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the invocation succeeded. ', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\\\n\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"operation success.\\",\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"4f63f9e9788449f9adc88d9438c8dec3\\",\\n \\"Channel\\": {\\n \\"ChannelId\\": \\"108293819\\",\\n \\"Token\\": \\"e59f61b2482b4d0562ab542da3f824f7\\",\\n \\"Type\\": \\"6\\",\\n \\"ExpiredTime\\": \\"2022-01-04T16:00Z\\",\\n \\"Nonce\\": \\"CK-9b5c335b9ae75879441ee7b363886418\\",\\n \\"UserId\\": \\"userId\\",\\n \\"AppId\\": \\"ONEX7E28C7C221854\\",\\n \\"UserInfoInChannel\\": \\"公有云音视频RTC需要的信息\\",\\n \\"Gslb\\": [\\n \\"djfls\\"\\n ]\\n },\\n \\"User\\": {\\n \\"UserId\\": \\"23423\\",\\n \\"UserName\\": \\"测试用户\\"\\n },\\n \\"Token\\": \\"879441ee7b363886418\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Query running digital human instances ', 'description' => 'This API currently returns only the most recent 100 running instances (shutdown instances are neither returned nor counted toward the 100-entry limit), sorted in reverse chronological order by start time. Instances beyond the latest 100 are not supported for retrieval at this time. Additionally, you can query the running status of an instance with a specific sessionId by providing the sessionId parameter. If the instance is running, it will be returned; otherwise, no information will be returned if the instance is not running or does not exist. (The software development kit must be upgraded to version 1.0.6 or later.)'."\n", 'responseParamsDescription' => 'When the sessionId parameter is provided, if this API does not return corresponding Data, it indicates that the instance associated with the sessionId is either not running or does not exist.'."\n", 'changeSet' => [ ['createdAt' => '2023-10-30T11:28:09.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-21T03:24:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-27T05:00:26.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRunningInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:QueryRunningInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryTimedResetOperateStatus' => [ 'summary' => 'This operation queries the power status of a specific digital human instance that supports start and stop operations. These instances are managed on the Instance Management page of the Digitized Virtual Human Open Platform.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Obtain the TenantId from the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxx', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'avatar_operation_public_cn-7pp2****802', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '74d42913-f13c-47ac-a8ac-8610685688eb'], 'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'operation success.', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- false: The call failed.'."\n" ."\n" .'- true: The call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'avatar_operation_public_cn-7pp2****802'."\n", 'title' => ''], 'StatusStr' => ['description' => 'A description of the instance\'s current power status.', 'type' => 'string', 'example' => '开机', 'title' => ''], 'TenantId' => ['description' => 'The TenantId obtained from the Digitized Virtual Human Open Platform.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'Status' => ['description' => 'The enumeration value of the instance\'s current power status:'."\n" ."\n" .'- 10: Started. The instance has started and is ready for use.'."\n" ."\n" .'- 11: Starting. The instance is starting up and is not yet available. Wait until the status changes to Started.'."\n" ."\n" .'- 20: Stopped. The instance has stopped and is not available.'."\n" ."\n" .'- 21: Stopping. The instance is shutting down and is not available.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74d42913-f13c-47ac-a8ac-8610685688eb\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"operation success.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InstanceId\\": \\"avatar_operation_public_cn-7pp2****802\\\\n\\",\\n \\"StatusStr\\": \\"开机\\",\\n \\"TenantId\\": \\"xxxxx\\",\\n \\"Status\\": 10\\n }\\n}","type":"json"}]', 'title' => 'API for Querying Power State of Power Control Instances ', 'description' => '**This operation can only query the status of digital human instances that support start and stop operations. It does not apply to other instance types.**'."\n" .'This operation returns the current power status of the instance. For details about the status values, see the response parameters section.'."\n" ."\n" .'>'."\n" ."\n" .'Set the polling interval to 3 seconds. Do not set the interval to less than 1 second. A shorter interval may trigger rate limiting.'."\n" ."\n" .'>', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:QueryTimedResetOperateStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTimedResetOperateStatus'], ], ], ], 'QueryVideoTaskInfo' => [ 'summary' => 'Query a list of submitted video synthesis tasks, with support for paging. You can filter tasks by digitized virtual human type, status, or title. Expired or canceled tasks cannot be queried.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarUCNFJ6'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. Get the TenantId from the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'App information representing a business configuration.', 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. Get the appId from the Developer Center > Instance Management page. For more information, see [the referenced document](https://help.aliyun.com/document_detail/479093.html?spm=a2c4g.2527854.0.0.6f124ecfkSTD3w#6a48daa1ee899).', 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskUuid', 'in' => 'query', 'schema' => ['description' => 'Task UUID returned when you submitted the corresponding video generation task.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxxx-xxx', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'Video task title to retrieve. The title must be fewer than 10 characters.', 'type' => 'string', 'required' => false, 'example' => '测试', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Task type:'."\n" ."\n" .'- 1: 3D digitized virtual human video synthesis.'."\n" ."\n" .'- 3: 2D digitized virtual human video synthesis.', 'type' => 'integer', 'format' => 'int32', 'enum' => ['1', '3'], 'required' => false, 'example' => '1', 'title' => '', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Task business status. Expired and canceled tasks cannot be queried:'."\n" ."\n" .'- 1: Waiting'."\n" ."\n" .'- 2: Running'."\n" ."\n" .'- 3: Success'."\n" ."\n" .'- 4: Failed'."\n" ."\n" .'If not specified, all statuses are queried by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enum' => ['1', '2', '3', '4'], 'example' => '3', 'title' => '', ], ], [ 'name' => 'OrderById', 'in' => 'query', 'schema' => [ 'description' => 'ID sort order. Use asc for ascending order (latest data last) or desc for descending order (latest data first).', 'type' => 'string', 'example' => 'desc', 'default' => 'desc', 'enum' => ['desc', 'asc'], 'required' => false, 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'Page number for paging. Starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of items per page for paging.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0A466686-8F3A-55A6-93D8-A0225DC965C0'."\n"], 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" ."\n" .'- false: The call failed.'."\n" ."\n" .'- true: The call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Error code', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '这是一个错误', 'title' => ''], 'Data' => [ 'description' => 'Data returned by the API call', 'type' => 'object', 'properties' => [ 'PageNo' => ['description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of video synthesis tasks', 'type' => 'array', 'items' => [ 'description' => 'Video synthesis task information', 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'Task UUID returned when you submitted the corresponding video generation task.', 'type' => 'string', 'example' => '789c45a5-2dca-4cd2-8fa7-f70a77e335ad', 'title' => ''], 'Title' => ['description' => 'Title of the submitted video synthesis task', 'type' => 'string', 'example' => '测试', 'title' => ''], 'Type' => ['description' => 'Task type:'."\n" ."\n" .'- 1: 3D digitized virtual human video synthesis.'."\n" ."\n" .'- 3: 2D digitized virtual human video synthesis.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Status' => ['description' => 'Task business status:'."\n" ."\n" .'- 1: Waiting'."\n" ."\n" .'- 2: Running'."\n" ."\n" .'- 3: Success'."\n" ."\n" .'- 4: Failed', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'TaskResult' => [ 'description' => 'Task result', 'type' => 'object', 'properties' => [ 'VideoUrl' => ['description' => 'Video URL', 'type' => 'string', 'example' => 'xxx/xxxx/xx.mp4'."\n", 'title' => ''], 'SubtitlesUrl' => ['description' => 'Caption URL', 'type' => 'string', 'example' => 'xxx/xxx/xxx.ass'."\n", 'title' => ''], 'WordSubtitlesUrl' => ['description' => 'Word-level timestamp file. Supported for specific tasks.', 'type' => 'string', 'example' => 'xxx/xxx/xxx.ass'."\n", 'title' => ''], 'VideoDuration' => ['description' => 'Generated video duration in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1111', 'title' => ''], 'FailReason' => ['description' => 'Failure reason', 'type' => 'string', 'example' => '这是一个失败原因'."\n", 'title' => ''], 'FailCode' => ['description' => 'Failure error code', 'type' => 'string', 'example' => '10001001', 'title' => ''], 'AlphaUrl' => ['description' => 'Alpha file corresponding to the MP4', 'type' => 'string', 'example' => 'xxx/xxx/xxx-alpha.mp4', 'title' => ''], 'PreviewPic' => ['description' => 'First-frame preview image of the video', 'type' => 'string', 'example' => 'xxxxx.png', 'title' => ''], 'AttachmentUrl' => ['description' => 'Video attachment URL. Supported for specific tasks.', 'type' => 'string', 'example' => 'xxx.ini'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A466686-8F3A-55A6-93D8-A0225DC965C0\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"这是一个错误\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TaskUuid\\": \\"789c45a5-2dca-4cd2-8fa7-f70a77e335ad\\",\\n \\"Title\\": \\"测试\\",\\n \\"Type\\": 1,\\n \\"Status\\": 3,\\n \\"TaskResult\\": {\\n \\"VideoUrl\\": \\"xxx/xxxx/xx.mp4\\\\n\\",\\n \\"SubtitlesUrl\\": \\"xxx/xxx/xxx.ass\\\\n\\",\\n \\"WordSubtitlesUrl\\": \\"xxx/xxx/xxx.ass\\\\n\\",\\n \\"VideoDuration\\": 1111,\\n \\"FailReason\\": \\"这是一个失败原因\\\\n\\",\\n \\"FailCode\\": \\"10001001\\",\\n \\"AlphaUrl\\": \\"xxx/xxx/xxx-alpha.mp4\\",\\n \\"PreviewPic\\": \\"xxxxx.png\\",\\n \\"AttachmentUrl\\": \\"xxx.ini\\\\n\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Query video synthesis job list ', 'description' => 'You can filter tasks by digitized virtual human type, status, or title. Expired or canceled tasks cannot be queried.', 'changeSet' => [ ['createdAt' => '2023-10-24T02:34:00.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-28T08:18:44.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'avatar:QueryVideoTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Render3dAvatar' => [ 'summary' => 'When you use the client-side rendering SDK, the SDK calls this operation to retrieve rendering data for a 3D avatar.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar9FRZ6U'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. The client SDK obtains this from its certificate.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'App ID. The client SDK obtains this from its certificate.', 'type' => 'string', 'required' => true, 'example' => 'dsdsf1', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'Avatar code.', 'type' => 'string', 'required' => true, 'example' => 'CH_2d_xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX'], 'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '这是一个错误', 'title' => ''], 'Data' => [ 'description' => 'Response data.', 'type' => 'object', 'properties' => [ 'RenderData' => ['description' => 'Rendering data for the avatar.', 'type' => 'string', 'example' => '{"xxxx":"xxxxxxxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"这是一个错误\\",\\n \\"Data\\": {\\n \\"RenderData\\": \\"{\\\\\\"xxxx\\\\\\":\\\\\\"xxxxxxxx\\\\\\"}\\"\\n }\\n}","type":"json"}]', 'title' => 'Character rendering data pulled by the client SDK ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:Render3dAvatar', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SendCommand' => [ 'summary' => 'Send an instruction message to the server. The digital human executes the corresponding instruction and renders the video stream to the user. Currently, only the interrupt instruction is supported.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID, obtained from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '76898bd3b90b4a65b1c078d8824a2e9c'."\n", 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'Session ID. Obtain it from the return value of the "Start a digital human" API.', 'type' => 'string', 'required' => true, 'example' => '5615', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'Instruction code: '."\n" .'- INTERRUPT: Interrupt the current digital human narration and stop the digital human from speaking. No content needs to be passed in Content. '."\n" .'- CHANGE_BACKGROUND: Switch the background. A background image URL must be provided in Content. For specific parameters, see the definition of the Content field (this instruction is not supported yet).', 'type' => 'string', 'required' => true, 'example' => 'INTERRUPT', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'Instruction content, in map format. Different instructions require different parameter content. This parameter can be omitted for instructions that do not require content. '."\n" .'

'."\n" .'

CHANGE_BACKGROUND

'."\n" .'{ '."\n" .' "backGroundImageUrl":"http://xxxxx.png" '."\n" .'} '."\n" .'

', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'UniqueCode', 'in' => 'query', 'schema' => ['description' => 'Unique code for the message request. Supports up to 64-bit values and must be unique. A UUID can be used.', 'type' => 'string', 'required' => true, 'example' => '0000001000586737'."\n", 'title' => ''], ], [ 'name' => 'Feedback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to send a callback notification when the digital human executes this message. Default value: false. For more information, see [Digital Human Callback Event Notifications](https://help.aliyun.com/document_detail/2261152.html?spm=openapi-amp.newDocPublishment.0.0.37e9281fRBn9wz). '."\n" .'>The INTERRUPT instruction does not currently support event callbacks.>', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0A466686-8F3A-55A6-93D8-A0225DC965C0'."\n"], 'Code' => ['description' => 'Code corresponding to the processing exception', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'Description corresponding to the processing exception', 'type' => 'string', 'example' => 'operation success.'."\n", 'title' => ''], 'Success' => ['description' => 'Whether the operation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => '9929391f61ef9e1c0000000000000006'."\n", 'title' => ''], 'UniqueCode' => ['description' => 'Unique code for the message request', 'type' => 'string', 'example' => '0000001000586737'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A466686-8F3A-55A6-93D8-A0225DC965C0\\\\n\\",\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"operation success.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SessionId\\": \\"9929391f61ef9e1c0000000000000006\\\\n\\",\\n \\"UniqueCode\\": \\"0000001000586737\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'Send an Instruction Message', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendCommand', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SendMessage' => [ 'summary' => 'Send a piece of broadcast text to the server. The digital human performs TTS generation, facial expression and action driving based on the text, and renders a video stream for the user. (We recommend using the upgraded APIs: SendText, SendVaml, or SendCommand.)'."\n", 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'Session ID. Obtain this value from the return value of the "Start a Digital Human" API.', 'type' => 'string', 'required' => false, 'example' => '76898bd3b90b4a65b1c078d8824a2e9c', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID obtained from the Digitized Virtual Human Open Platform.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5615', 'title' => ''], ], [ 'name' => 'TextRequest', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Text to be spoken', 'type' => 'object', 'properties' => [ 'CommandType' => ['description' => 'Command type:'."\n" .'- START indicates starting to speak a segment of text.'."\n" .'- HOLDING indicates pausing the current speech.'."\n" .'- RESUME indicates resuming the current speech.', 'type' => 'string', 'required' => false, 'example' => '枚举值如下：'."\n" .'START 表示开始播报一段文本'."\n" .'HOLDING 表示暂停当前播报'."\n" .'RESUME 表示恢复当前播报', 'title' => ''], 'SpeechText' => ['description' => 'Content of the text to be spoken. Currently supports plain text and Alibaba Cloud Intelligent Speech Synthesis SSML markup language (for SSML usage guidelines, refer to [Official Documentation](https://help.aliyun.com/document_detail/462017.html)). The maximum text length is 1000 characters (excluding tags).', 'type' => 'string', 'required' => false, 'example' => '纯文本：这是一段示例播报纯文本'."\n" .'SSML：SSML使用请参考官方文档', 'title' => ''], 'Id' => ['description' => 'ID corresponding to the SpeechText content. Supports up to 64-bit values and must be unique. A UUID can be used.', 'type' => 'string', 'required' => false, 'example' => '0000001000586737', 'title' => ''], 'interrupt' => ['description' => 'Specifies whether to interrupt the previous speech during playback. By default, interruption is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'VAMLRequest', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'VAML protocol request object.'."\n", 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'VAML request type: this field can be left blank by default.', 'type' => 'string', 'required' => false, 'example' => 'VAML_REQUEST', 'title' => ''], 'Vaml' => ['description' => 'VAML protocol request. For details, see [Official Documentation](https://help.aliyun.com/document_detail/444010.html).', 'type' => 'string', 'required' => false, 'example' => '参考文档', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Feedback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to send a callback notification when the digital human delivers this message. The default value is false. For more information, see [Digital Human Callback Event Notifications](https://help.aliyun.com/document_detail/2261152.html).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'StreamExtension', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Stream extension object. Do not pass this object if streaming broadcast is not used. The user must split the text into segments (for example, by punctuation marks), and the digital human broadcasts the segments consecutively in the order they are submitted.'."\n", 'type' => 'object', 'properties' => [ 'IsStream' => ['description' => 'Indicates whether streaming broadcast is enabled.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'Index' => ['description' => 'Index of the current segment in the streaming broadcast.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Position' => ['description' => 'Segment position'."\n" ."\n" .'- start – First segment'."\n" .'- mid – Middle segment'."\n" .'- end – Last segment'."\n", 'type' => 'string', 'required' => false, 'example' => 'start', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'QUERY_ACCOUNT_INFO_ERROR'], 'Message' => ['description' => 'The message returned by the API call.'."\n", 'type' => 'string', 'example' => 'operation success.', 'title' => ''], 'Data' => [ 'description' => 'Return Result'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID'."\n", 'type' => 'string', 'example' => '0A466686-8F3A-55A6-93D8-A0225DC965C0', 'title' => ''], 'SessionId' => ['description' => 'Session ID'."\n", 'type' => 'string', 'example' => '9929391f61ef9e1c0000000000000006', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the operation succeeded.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"QUERY_ACCOUNT_INFO_ERROR\\",\\n \\"Message\\": \\"operation success.\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"0A466686-8F3A-55A6-93D8-A0225DC965C0\\",\\n \\"SessionId\\": \\"9929391f61ef9e1c0000000000000006\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Send Text Message'."\n", 'description' => 'For information about importing the second-party package, refer to the API Overview.'."\n", 'changeSet' => [ ['createdAt' => '2023-06-13T03:17:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-05-10T07:28:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-28T03:09:42.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendMessage'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SendText' => [ 'summary' => 'Send a text message to the server. The digital human reads out the corresponding text and renders the video stream for the user.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarLCBTNG'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID, obtained from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '76898bd3b90b4a65b1c078d8824a2e9c', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'Session ID. Obtain it from the return value of the "Start a Digital Human" API.', 'type' => 'string', 'required' => true, 'example' => '5615', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'Content of the text to be broadcast. Currently supports plain text and Alibaba Cloud Intelligent Speech Synthesis SSML (Speech Synthesis Markup Language). For details on using SSML, refer to the [official documentation](https://help.aliyun.com/document_detail/462017.html?spm=openapi-amp.newDocPublishment.0.0.37e9281fRBn9wz). The maximum text length is 1000 characters (excluding tags).', 'type' => 'string', 'required' => true, 'example' => '纯文本：这是一段示例播报纯文本'."\n" .'SSML：SSML使用请参考官方文档'."\n", 'title' => ''], ], [ 'name' => 'Interrupt', 'in' => 'query', 'schema' => ['description' => 'Specifies whether this broadcast request interrupts the currently playing content. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], [ 'name' => 'UniqueCode', 'in' => 'query', 'schema' => ['description' => 'Unique code for the broadcast request. Supports up to 64-bit and must be unique. You can use a UUID.', 'type' => 'string', 'required' => true, 'example' => '0000001000586737', 'title' => ''], ], [ 'name' => 'Feedback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to send a callback notification when the digital human broadcasts this message. The default value is false. For more information, see [Digital Human Callback Event Notifications](https://help.aliyun.com/document_detail/2261152.html?spm=openapi-amp.newDocPublishment.0.0.37e9281fRBn9wz).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'StreamExtension', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Extender object for streaming playback. If not using streaming playback, do not pass this object. The user must split the text into segments (for example, by punctuation marks), and the digital human will continuously read out the submitted text segments in order.', 'type' => 'object', 'properties' => [ 'IsStream' => ['description' => 'Whether streaming playback is used', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'Index' => ['description' => 'Index of the current segment in streaming playback', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Position' => ['description' => 'Segment position'."\n" ."\n" .'1. start - The first starting segment '."\n" .'2. mid - A middle segment '."\n" .'3. end - The final ending segment', 'type' => 'string', 'required' => false, 'example' => 'start', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0A466686-8F3A-55A6-93D8-A0225DC965C0'."\n"], 'Code' => ['description' => 'Code corresponding to the returned processing exception', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'Description corresponding to the returned processing exception', 'type' => 'string', 'example' => 'operation success.'."\n", 'title' => ''], 'Success' => ['description' => 'Whether the operation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => '9929391f61ef9e1c0000000000000006'."\n", 'title' => ''], 'UniqueCode' => ['description' => 'Unique code of the request', 'type' => 'string', 'example' => '0000001000586737', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A466686-8F3A-55A6-93D8-A0225DC965C0\\\\n\\",\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"operation success.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SessionId\\": \\"9929391f61ef9e1c0000000000000006\\\\n\\",\\n \\"UniqueCode\\": \\"0000001000586737\\"\\n }\\n}","type":"json"}]', 'title' => 'Send a plain text message', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SendVaml' => [ 'summary' => 'Send a VAML text message to the server. The digital human reads out the corresponding text and renders the video stream to the user.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarLCBTNG'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID, obtained from the digitized virtual human Open Platform', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5615', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'Session ID. You can obtain it from the return value of the "Start a digital human" API.', 'type' => 'string', 'required' => true, 'example' => '76898bd3b90b4a65b1c078d8824a2e9c'."\n", 'title' => ''], ], [ 'name' => 'Vaml', 'in' => 'query', 'schema' => ['description' => 'VAML protocol request. For details, see the [official document](https://help.aliyun.com/document_detail/444010.html?spm=openapi-amp.newDocPublishment.0.0.37e9281fRBn9wz).', 'type' => 'string', 'required' => true, 'example' => '参考文档'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0A466686-8F3A-55A6-93D8-A0225DC965C0'."\n"], 'Code' => ['description' => 'Code corresponding to the processing abnormality', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'Description corresponding to the processing abnormality', 'type' => 'string', 'example' => 'operation success.'."\n", 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Return Result', 'type' => 'object', 'properties' => [ 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => '76898bd3b90b4a65b1c078d8824a2e9c', 'title' => ''], 'UniqueCode' => ['description' => 'Unique code of the request, corresponding to the uniqueCode in the VAML content', 'type' => 'string', 'example' => '0000001000586737', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A466686-8F3A-55A6-93D8-A0225DC965C0\\\\n\\",\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"operation success.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SessionId\\": \\"76898bd3b90b4a65b1c078d8824a2e9c\\",\\n \\"UniqueCode\\": \\"0000001000586737\\"\\n }\\n}","type":"json"}]', 'title' => 'Send a VAML text message', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendVaml', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'StartInstance' => [ 'summary' => 'Start an instance of a digital human video stream. By passing in specified parameters, you can start a digital human instance. For digital human instances that use the platform\'s default video stream channel—such as broadcasting digital humans and interactive digital humans—this API returns the parameters required for stream pulling from Alibaba Cloud\'s public RTC service. You do not need to separately activate the Alibaba Cloud RTC product service. Instead, you can directly use the Alibaba Cloud RTC stream pulling software development kit (SDK) together with the Channel parameter returned by this API to perform stream pulling. For documentation on integrating the Alibaba Cloud RTC stream pulling SDK, refer to the "Client SDK Integration" document in the Digital Human Open Platform Help Center.'."\n", 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID, obtained from the developer information of the corresponding business configuration in the digitized virtual human Open Platform ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9185', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Represents a business configuration ', 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'AppId, obtained from the developer information of the corresponding business configuration in the digitized virtual human Open Platform ', 'type' => 'string', 'required' => false, 'example' => 'ALIPUB5748B17121450', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'User', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'User information for starting this digital human (such as the Customer\'s own user information or device ID; if unavailable, a random number can be passed directly) ', 'type' => 'object', 'properties' => [ 'UserId' => ['description' => 'The Customer\'s own User ID, device ID, or similar identifier. If none is available, a random number can be passed directly.', 'type' => 'string', 'required' => false, 'example' => '23423', 'title' => ''], 'UserName' => ['description' => 'The username corresponding to the User ID. This field can be empty.', 'type' => 'string', 'required' => false, 'example' => '测试用户', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Channel', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Channel information for pushing the digital human streaming media to a specified Channel. Standard RTMP protocol is currently supported.'."\n" ."\n" .'>'."\n" ."\n" .'- For the **Consultation Broadcasting** scenario (corresponding to the "Broadcast Digital Human" in official documentation) and the **Customer Service Assistant** scenario (corresponding to the "Interactive Digital Human" in official documentation), pass the DingRTC channel type. The platform will use the DingRTC channel for stream ingest. Additionally, official documentation provides a [stream pulling SDK](https://help.aliyun.com/document_detail/479357.html?spm=a2c4g.479356.0.0.170a6d79vSe56q) to facilitate Integration.'."\n" .'- Only for the **Virtual Streamer** scenario (corresponding to the "Stream Ingest Digital Human" in official documentation) should you pass the corresponding stream ingest parameter information.'."\n" ."\n\n" .'>', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'Channel type: '."\n" .'- RTMP: RTMP stream ingest '."\n" .'- DingRTC: DingRTC channel type ', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['MRTC' => 'MRTC', 'RTMP' => 'RTMP'], 'example' => 'RTMP', 'title' => '', ], 'ReqConfig' => ['description' => 'Channel request protocol body, of map type. '."\n" ."\n" .'- RTMP: '."\n" .'``` '."\n" .'{"url": ""} '."\n" .'- url: The RTMP ingest URL of the live streaming platform. '."\n" .'``` '."\n" .'>For some live streaming platforms that split the ingest URL into a URL and a token, you can concatenate both parts and pass them together in the url field. Obtain the ingest URL from the corresponding live streaming platform. Note that some platforms do not allow third-party stream ingest and therefore do not provide an RTMP ingest URL. ', 'type' => 'object', 'required' => false, 'example' => 'RTMP协议体：'."\n" .'{'."\n" .' "url" : "rtmp的地址"'."\n" .'}', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'CommandRequest', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Digital human command execution request', 'type' => 'object', 'properties' => [ 'AlphaSwitch' => ['description' => 'Indicates whether transparency is required. If transparency is needed, set AlphaSwitch=true in the AliRTC communication channel, and the stream pulling client must integrate the streaming media pull-stream SDKs: [Digital Human Streaming Media Service Android SDK](https://help.aliyun.com/document_detail/479357.html?spm=a2c4g.479358.0.0.65c055280G4RF9) and [Digital Human Streaming Media Service Web SDK](https://help.aliyun.com/document_detail/479358.html?spm=a2c4g.479357.0.0.509d66c9WmAwUh). Refer to the References documentation to implement the corresponding transparent effect (search for the keyword “transparent” in the document). DingRTC communication channels do not currently support transparency-related features.', 'type' => 'boolean', 'required' => false, 'example' => 'true：透明通道'."\n" .'false：非透明通道', 'title' => ''], 'BackGroundImageUrl' => ['description' => 'A valid and accessible URL of the background image. The aspect ratio of the background image must match that of the generated video.'."\n" ."\n" .'- Currently supported image formats are JPG, JPEG, and PNG.', 'type' => 'string', 'required' => false, 'example' => '可访问的公网url地址', 'title' => ''], 'Locate' => ['description' => 'Digital human camera position:'."\n" .'- 0: Full-body close-up (default)'."\n" .'- 1: Head close-up'."\n" .'- 2: Full-body long shot'."\n" .'- 3: Upper-body close-up'."\n" .'- 4: Upper-body long shot'."\n" .'- 5: Left-side close-up'."\n" .'- 6: Right-side close-up'."\n" ."\n" .'For previews of each camera position, see: [3D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/447834.html#9c8a96707515k)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'BizId', 'in' => 'query', 'schema' => ['description' => 'Business request ID, supporting up to 64 characters.You can use this field to ensure idempotency when starting a digital human instance. The server guarantees that multiple invocations with the same bizId will start only one ingest endpoint instance. ', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxx', 'title' => ''], ], [ 'name' => 'TextRequest', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Configuration parameters related to the spoken content ', 'type' => 'object', 'properties' => [ 'PitchRate' => ['description' => 'TTS voice pitch for speech synthesis. Value range: -500 to 500. If not specified, the default value configured in the asset is used. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'SpeechRate' => ['description' => 'TTS speech rate for speech synthesis. Value range: -500 to 500. If not specified, the default value configured in the asset is used. '."\n" ."\n" .'The speech rate values [-500, 0, 500] correspond to speed multipliers [0.5, 1.0, 2.0], respectively: '."\n" ."\n" .'- -500 represents 0.5× the base speech rate; '."\n" .'- 0 represents 1.0× the base speech rate. The base rate (1.0×) is the default synthesized speech speed of the model, which varies slightly per speaker and is approximately 4 characters per second; '."\n" .'- 500 represents 2.0× the base speech rate. '."\n" ."\n" .'The calculation method is as follows: '."\n" ."\n" .'For 0.8× speed: (1 - 1/0.8) / 0.002 = -125 '."\n" ."\n" .'For 1.2× speed: (1 - 1/1.2) / 0.001 = 166 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Voice' => ['description' => 'TTS voice speaker code. Obtain this from the 2D Asset Management page of the Digitized Virtual Human Open Platform. If not specified, the speaker configured in the asset is used. ', 'type' => 'string', 'required' => false, 'example' => 'guijie', 'title' => ''], 'Volume' => ['description' => 'TTS voice volume for speech synthesis. Value range: 0 to 100. If not specified, the default value configured in the asset is used. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return Result code ', 'type' => 'string', 'example' => '0', 'title' => ''], 'Message' => ['description' => 'Return message'."\n", 'type' => 'string', 'example' => '错误信息示例', 'title' => ''], 'Data' => [ 'description' => 'Return Result'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID'."\n", 'type' => 'string', 'example' => '4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'SessionId' => ['description' => 'Session ID. This is the unique identifier for this digitized virtual human instance. You must pass this ID when sending broadcast text or stopping the digitized virtual human instance. If lost, you can retrieve it by invoking the "Query running digitized virtual human instances" API. ', 'type' => 'string', 'example' => '4f63f9e9788449f9adc88d9438c8dec3', 'title' => ''], 'Channel' => [ 'description' => 'Channel information. Currently, this field returns channel information for DingRTC channels used by interactive and broadcasting digital human video streams, which is intended for client-side stream pulling. This field will not return corresponding information for interactive or stream ingest digital humans that use third-party stream ingest channels, such as RTMP stream ingest.'."\n", 'type' => 'object', 'properties' => [ 'ChannelId' => ['description' => 'channel ID ', 'type' => 'string', 'example' => '108293819', 'title' => ''], 'Token' => ['description' => 'DingRTC token. ', 'type' => 'string', 'example' => 'e59f61b2482b4d0562ab542da3f824f7', 'title' => ''], 'Type' => ['description' => 'Channel type'."\n", 'type' => 'string', 'example' => '6', 'title' => ''], 'ExpiredTime' => ['description' => 'Expiration Time of the DingRTC channel ', 'type' => 'string', 'example' => '1677112265876', 'title' => ''], 'Nonce' => ['description' => 'A random string generated by the DingRTC server.'."\n", 'type' => 'string', 'example' => 'CK-9b5c335b9ae75879441ee7b363886418', 'title' => ''], 'UserId' => ['description' => 'UserId generated by DingRTC ', 'type' => 'string', 'example' => 'userId', 'title' => ''], 'AppId' => ['description' => 'DingRTC application ID', 'type' => 'string', 'example' => 'ONEX7E28C7C221854', 'title' => ''], 'UserInfoInChannel' => ['description' => 'Information required by Alibaba Cloud RTC'."\n", 'type' => 'string', 'example' => '公有云音视频RTC需要的信息', 'title' => ''], 'Gslb' => [ 'description' => 'RTC channel addresses'."\n", 'type' => 'array', 'items' => ['description' => 'RTC channel address'."\n", 'type' => 'string', 'example' => 'https://rgslb.rtc.aliyuncs.com', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Token' => ['description' => 'Authentication token required for integration with interactive digital human. For details, refer to the interactive digital human integration document. ', 'type' => 'string', 'example' => '879441ee7b363886418', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the invocation succeeded. ', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"错误信息示例\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"SessionId\\": \\"4f63f9e9788449f9adc88d9438c8dec3\\",\\n \\"Channel\\": {\\n \\"ChannelId\\": \\"108293819\\",\\n \\"Token\\": \\"e59f61b2482b4d0562ab542da3f824f7\\",\\n \\"Type\\": \\"6\\",\\n \\"ExpiredTime\\": \\"1677112265876\\",\\n \\"Nonce\\": \\"CK-9b5c335b9ae75879441ee7b363886418\\",\\n \\"UserId\\": \\"userId\\",\\n \\"AppId\\": \\"ONEX7E28C7C221854\\",\\n \\"UserInfoInChannel\\": \\"公有云音视频RTC需要的信息\\",\\n \\"Gslb\\": [\\n \\"https://rgslb.rtc.aliyuncs.com\\"\\n ]\\n },\\n \\"Token\\": \\"879441ee7b363886418\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Start a digital human ', 'description' => 'For information about importing the second-party package, refer to the API Overview.'."\n", 'changeSet' => [ ['createdAt' => '2024-01-24T07:05:50.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-08T09:38:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-25T07:04:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-05T07:52:58.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:StartInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'StartTimedResetOperate' => [ 'summary' => 'This operation powers on specified digital human timed reset instances. You can find these instances on the Instance Management page of the Digital Human Open Platform. This operation is equivalent to clicking the power-on button on the page.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. Get this from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxxx', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID. Get this from the Instance Management page in the digitized virtual human Open Platform.', 'type' => 'string', 'required' => true, 'example' => 'avatar_operation_public_cn-7pp2****802'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'], 'Code' => ['description' => 'Return code', 'type' => 'string', 'example' => '0', 'title' => ''], 'Message' => ['description' => 'Return message', 'type' => 'string', 'example' => 'operation success.', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call succeeded.'."\n" ."\n" .'- false: The call failed.'."\n" ."\n" .'- true: The call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Call result data', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'avatar_operation_public_cn-7pp2****802', 'title' => ''], 'TenantId' => ['description' => 'Tenant ID from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"operation success.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InstanceId\\": \\"avatar_operation_public_cn-7pp2****802\\",\\n \\"TenantId\\": 0\\n }\\n}","type":"json"}]', 'title' => 'Power-On API for Start/Stop Operations', 'description' => '**Before you call this operation, review the [billing methods and pricing](https://help.aliyun.com/document_detail/457248.html#1e716e704bcf5) for the Digital Human Timed Reset product.**'."\n" ."\n" .'**This operation powers on only timed reset instances. It does not support non-timed reset instances.** A successful call indicates that the system has received your request. The instance status changes to \'Powering on\'. The system then begins to power on the instance. **The power-on process typically takes 1 to 5 minutes. If platform resources are insufficient, the process may take longer.** After you call this operation, you can poll the [Timed Reset Instance Power Status Query interface](https://help.aliyun.com/document_detail/475509.html) to check the power-on status. **We recommend that you poll at an interval of 3 seconds. Do not poll more than once per second, or you may trigger rate limiting.**'."\n" ."\n" .'>'."\n" ."\n" .'Instances in the \'Powering on\' status are unavailable. You can use an instance only after the power-on process is complete and its status changes to \'Powered on\'. Billing starts after the power-on process is complete.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartTimedResetOperate'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:StartTimedResetOperate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'StopInstance' => [ 'summary' => 'Shut down a digital human instance and stop stream ingest.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar1PRWQW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The TenantId obtained from the developer information in the business configuration of the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '234234', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => ['description' => 'Session SessionID. Obtain it from the return value of the "Start a digital human" API.', 'type' => 'string', 'required' => false, 'example' => '9adb569b-f66b-4e92-8b9d-62aa626f8318', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response Result', 'type' => 'object', 'properties' => [ 'Code' => ['title' => 'Id of the request', 'description' => 'Response code', 'type' => 'string', 'example' => '0'], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => '错误信息示例', 'title' => ''], 'Data' => [ 'description' => 'Return Result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => ' 4C467B38-3910-447D-87BC-AC049166F216', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '6296cc143d2c42899dae6eff19e8ac28', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"错误信息示例\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\" 4C467B38-3910-447D-87BC-AC049166F216\\",\\n \\"SessionId\\": \\"6296cc143d2c42899dae6eff19e8ac28\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Stop a digital human', 'description' => 'For information about importing the second-party package, see the API overview.', 'changeSet' => [ ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-03-01T03:47:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopInstance'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:StopInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitAudioTo2DAvatarVideoTask' => [ 'summary' => 'Submit an offline task to generate a 2D digital human video from a WAV audio file. This operation returns a unique TaskUuid immediately. You can use the TaskUuid to query or cancel the task later.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar74USDX'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. Get this value from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20516', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'App information. Represents a business configuration.', 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. Get this value from the Developer Center > Instance Management page. For details, see [References](https://help.aliyun.com/document_detail/479093.html?spm=a2c4g.447644.0.0.406f66c95dI2Ee#6a48daa1ee899).', 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'Task title for the video synthesis. Maximum length: 32 characters.', 'type' => 'string', 'required' => true, 'example' => '常吃的皮蛋一般是由哪一种蛋加工而成的？', 'title' => ''], ], [ 'name' => 'VideoInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Video configuration.', 'type' => 'object', 'properties' => [ 'IsAlpha' => ['description' => 'Enable the alpha channel. Default: false.'."\n" ."\n" .'- true: Enable the alpha channel. Set the video format using AlphaFormat. Supported formats: webm, mov, mp4.'."\n" ."\n" .'- false: Disable the alpha channel. The video format is mp4.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], 'BackgroundImageUrl' => ['description' => 'URL of a publicly accessible background image. The image resolution must match the output video resolution. Supported formats: jpg, jpeg, png.', 'type' => 'string', 'required' => false, 'example' => '可访问的公网url地址', 'title' => ''], 'Resolution' => ['description' => 'Output video resolution. Supported resolutions vary by digital human:'."\n" ."\n" .'- 3: 1080 × 1920 (portrait)'."\n" ."\n" .'- 4: 1920 × 1080 (landscape)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], 'AlphaFormat' => [ 'description' => 'Alpha channel format. Default: 1.'."\n" ."\n" .'- 1: webm'."\n" ."\n" .'- 2: mov'."\n" ."\n" .'- 3: mp4'."\n" ."\n" .'>Ignore this field when IsAlpha is false. MOV files with alpha channels are very large. We recommend using webm or mp4 instead.>'."\n" .'>Some 2D digitized virtual humans do not support alpha-channel video. Official Alibaba Cloud digital humans support alpha-channel output. For custom digital humans, alpha-channel support depends on your selection during customization.>', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'enum' => [], 'required' => false, 'example' => '1', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AvatarInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Digital human configuration.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Digital human code. Get this value from the digitized virtual human Open Platform > 2D Assets page. If omitted, the default digital human from the app configuration is used.', 'type' => 'string', 'required' => false, 'example' => 'CH_2d_xxxxxxx', 'title' => ''], 'X' => ['description' => 'Horizontal pixel offset of the digital human layer from the top-left corner of the frame. Default: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Y' => ['description' => 'Vertical pixel offset of the digital human layer from the top-left corner of the frame. Default: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Width' => ['description' => 'Width of the digital human layer.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '数字人底板视频为横屏：1920'."\n" .'数字人底板视频为竖屏：1080', 'title' => ''], 'Height' => ['description' => 'Height of the digital human layer.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '数字人底板视频为横屏：1080'."\n" .'数字人底板视频为竖屏：1920', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AudioInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Audio configuration.', 'type' => 'object', 'properties' => [ 'SampleRate' => [ 'description' => 'Output audio sampling rate in Hz.', 'enumValueTitles' => [16000 => '16000', 24000 => '24000', 48000 => '48000'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16000', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => ['description' => '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 depth.', 'type' => 'string', 'required' => true, 'example' => '可访问的公网url地址', 'title' => ''], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => ['description' => 'Enable event callbacks for this video synthesis task. Default: false. Alibaba Cloud supports callbacks at task start and task completion. For details, see [Digital Human Callback Events](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.447644.0.0.406f5876hRJTVU).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CallbackParams', 'in' => 'query', 'schema' => ['description' => 'Parameters to pass through with the callback. Must be a JSON string. Ignored when Callback is false.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xxx": "xxx"'."\n" .'}', 'title' => ''], ], [ 'name' => 'ExtParams', 'in' => 'query', 'schema' => ['description' => 'Additional parameters.', 'type' => 'string', 'required' => false, 'example' => '{"xxx": "xxx"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX'], 'Code' => ['description' => 'Error code', 'type' => 'string', 'example' => '10050008', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '这个一个错误消息。', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Response data', 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'Unique task ID. Save this value to query task details later.', 'type' => 'string', 'example' => 'xxxx-xxx-xx-xx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX\\",\\n \\"Code\\": \\"10050008\\",\\n \\"Message\\": \\"这个一个错误消息。\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskUuid\\": \\"xxxx-xxx-xx-xx\\"\\n }\\n}","type":"json"}]', 'title' => 'Submit a 2D Audio-to-Video Synthesis Job ', 'description' => 'Submit an offline task to generate a 2D digital human video from a WAV audio file. This operation returns a unique TaskUuid immediately. Use the TaskUuid to call the [Query Video Synthesis Task Details](https://help.aliyun.com/document_detail/447640.html) operation to check the task status. When the status is Completed, you can retrieve the download URL for the video and download it. If the status is Not Started, you can use the TaskUuid to call the [Cancel Video Synthesis Task](https://help.aliyun.com/document_detail/447642.html) operation to cancel the task.'."\n" ."\n" .'> For the full integration workflow, see the [2D Digital Human Video Synthesis Guide](https://help.aliyun.com/document_detail/448147.html?spm=a2c4g.447834.0.0.13666d79MiKZX4).', 'changeSet' => [ ['createdAt' => '2024-01-08T08:42:05.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-14T06:13:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-01T09:10:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-06-25T03:13:13.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAudioTo2DAvatarVideoTask'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitAudioTo2DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitAudioTo3DAvatarVideoTask' => [ 'summary' => 'Submits a task to generate a 3D digital human video from a WAV audio file. This operation immediately returns a TaskUuid as the unique ID for the task. You can use the TaskUuid to query or cancel the task later.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarUCNFJ6'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Obtain this ID from the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The application information, which represents a business configuration.', 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'The app ID. Obtain the app ID on the Instance Management page in the Developer Center. For more information, see [this document](https://help.aliyun.com/document_detail/479093.html?spm=a2c4g.447644.0.0.406f66c95dI2Ee#6a48daa1ee899).', 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the video synthesis task. The title can be up to 32 characters long.', 'type' => 'string', 'required' => true, 'example' => '这是一个示例标题', 'title' => ''], ], [ 'name' => 'VideoInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The video configuration.', 'type' => 'object', 'properties' => [ 'Resolution' => ['description' => 'The resolution of the generated video. The following resolutions are supported:'."\n" ."\n" .'- 1: 720 × 1280 (portrait)'."\n" ."\n" .'- 2: 1280 × 720 (landscape)'."\n" ."\n" .'- 3: 1080 × 1920 (portrait)'."\n" ."\n" .'- 4: 1920 × 1080 (landscape)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'IsAlpha' => ['description' => 'Specifies whether to enable the alpha channel. The default value is false.'."\n" ."\n" .'- \\`true\\`: Enables the alpha channel. You can use the \\`AlphaFormat\\` parameter to specify the video format. Supported formats are webm, mov, and mp4.'."\n" ."\n" .'- \\`false\\`: Disables the alpha channel. The video format is mp4.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'BackgroundImageUrl' => ['description' => 'A valid and accessible URL of the background image. The resolution of the background image must be the same as that of the generated video.'."\n" ."\n" .'- Supported image formats are JPG, JPEG, and PNG.', 'type' => 'string', 'required' => false, 'example' => '可访问的公网url地址', 'title' => ''], 'AlphaFormat' => [ 'description' => 'The format of the alpha channel. The default value is 1.'."\n" ."\n" .'- 1: webm'."\n" ."\n" .'- 2: mov'."\n" ."\n" .'- 3: mp4'."\n" ."\n" .'>'."\n" ."\n" .'This parameter is ignored if \\`IsAlpha\\` is set to \\`false\\`. The MOV format creates very large transparent video files. Use the WebM or MP4 format instead.'."\n" ."\n" .'>', 'type' => 'integer', 'format' => 'int32', 'enum' => [], 'required' => false, 'example' => '1', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AvatarInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The configuration of the digital human.', 'type' => 'object', 'properties' => [ 'Locate' => ['description' => 'The camera position for the digital human.'."\n" ."\n" .'- 0: Full-body close-up shot. This is the default position.'."\n" ."\n" .'- 1: Head close-up shot'."\n" ."\n" .'- 2: Full-body long shot'."\n" ."\n" .'- 3: Half-body close-up shot'."\n" ."\n" .'- 4: Half-body long shot'."\n" ."\n" .'- 5: Left close-up shot'."\n" ."\n" .'- 6: Right close-up shot'."\n" ."\n" .'For a preview of each camera position, see: [3D digital human video synthesis user guide](https://help.aliyun.com/document_detail/447834.html#9c8a96707515k)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Angle' => ['description' => 'The angle of the digital human.'."\n" ."\n" .'- 0: Front. This is the default angle.'."\n" ."\n" .'- 1: 30 degrees to the left'."\n" ."\n" .'- 2: 30 degrees to the right'."\n" ."\n" .'For a preview of each angle, see: [3D digital human video synthesis user guide](https://help.aliyun.com/document_detail/447834.html#a989eb5075t9y)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Code' => ['description' => 'The code of the digital human.'."\n" .'>The audio synthesis feature currently supports only the following digital humans: Bonnie, Stella, Daisy, and any new digital humans created based on them.>', 'type' => 'string', 'required' => false, 'example' => 'CH_xxxxxxx', 'title' => ''], 'IndustryCode' => ['description' => 'The industry code. The default value is \\`default\\`.'."\n" ."\n" .'- default: General'."\n" ."\n" .'- kefu: Customer service'."\n" ."\n" .'- live: Live streaming', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => ['description' => '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 have a bit depth of 16 bits.', 'type' => 'string', 'required' => true, 'example' => '可访问的公网url地址'."\n", 'title' => ''], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to receive event callbacks for the video synthesis task. The default value is \\`false\\`. The platform can send callbacks when a task starts and when it ends. For more information, see [Digital human callback notifications](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.447644.0.0.406f5876hRJTVU).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CallbackParams', 'in' => 'query', 'schema' => ['description' => 'The parameters that you want to pass through in the callback. This parameter must be a JSON string. This parameter is invalid if \\`Callback\\` is set to \\`false\\`.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xxx": "xxx"'."\n" .'}', 'title' => ''], ], [ 'name' => 'ExtParams', 'in' => 'query', 'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{"xxx": "xxx"}', 'title' => ''], ], [ 'name' => 'AudioInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The audio configuration.', 'type' => 'object', 'properties' => [ 'SampleRate' => [ 'description' => 'The audio sampling rate of the output. Unit: Hz.', 'enumValueTitles' => [16000 => '16000', 24000 => '24000', 48000 => '48000'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16000', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '10050008', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '这个一个错误消息。', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'The unique UUID of the task. Save this UUID. You can use it to query the task details later.', 'type' => 'string', 'example' => 'xxxx-xxx-xx-xx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"10050008\\",\\n \\"Message\\": \\"这个一个错误消息。\\",\\n \\"Data\\": {\\n \\"TaskUuid\\": \\"xxxx-xxx-xx-xx\\"\\n }\\n}","type":"json"}]', 'title' => 'Submit a 3D Audio-to-Video Synthesis Job '."\n", 'description' => 'Submits an offline task to generate a 3D digital human video from a WAV audio file. This operation immediately returns a \\`TaskUuid\\` as the unique ID for the task. You can use the \\`TaskUuid\\` to call the [QueryVideoSynthesisTask](https://help.aliyun.com/document_detail/447640.html) operation to check the task status. When the task is complete, you can obtain the video download URL to download the video. If the task has not started, you can also use the \\`TaskUuid\\` to call the [CancelVideoSynthesisTask](https://help.aliyun.com/document_detail/447642.html) operation to cancel the task.'."\n" ."\n" .'> For more information about the complete 3D video synthesis process, see [3D digital human video synthesis user guide](https://help.aliyun.com/document_detail/447834.html?spm=a2c4g.446838.0.0.54a96d79OAZR9X).'."\n" ."\n" .'>'."\n" ."\n" .'The audio synthesis feature currently supports only the following digital humans: Bonnie, Stella, Daisy, and any new digital humans created based on them.'."\n" ."\n" .'>', 'changeSet' => [ ['createdAt' => '2024-01-08T08:42:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-01T09:10:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-07-05T02:23:52.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-25T03:13:14.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAudioTo3DAvatarVideoTask'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitAudioTo3DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitAvatarVideoTask' => [ 'summary' => 'Submit a task to generate a video of a digitized virtual human.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREavatar74USDX'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID. Obtain the TenantId from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'App information, representing a business configuration.', 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. Obtain the corresponding AppId from the Developer Center > Instance Management page. For more information, see [the referenced document]().', 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the submitted video synthesis task.', 'type' => 'string', 'required' => true, 'example' => '这是一个示例标题', 'title' => ''], ], [ 'name' => 'VideoParams', 'in' => 'query', 'schema' => ['description' => 'Related parameters required for the synthesized video.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" .' "text": "测试",'."\n" .' "characterCode": "CH_xxxxxx"'."\n" .' }', 'title' => ''], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => ['description' => 'Whether this video synthesis task requires an event callback. The default is false, meaning no callback. The platform supports event callbacks at the start and end of a task. For details, see [Digitized Virtual Human Callback Event Notifications]().', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CallbackParams', 'in' => 'query', 'schema' => ['description' => 'Parameters to pass through during the callback, in JSON string format. This parameter does not take effect when Callback is set to false.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xxx": "xxx"'."\n" .'}', 'title' => ''], ], [ 'name' => 'ExtParams', 'in' => 'query', 'schema' => ['description' => 'Extension parameters.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xxx": "xxx"'."\n" .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'."\n"], 'Success' => ['description' => 'Whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => '10050008'."\n", 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '这个一个错误消息。'."\n", 'title' => ''], 'Data' => [ 'description' => 'Call result data.', 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'Unique task UUID. Use this to query task details later. Make sure to save it.', 'type' => 'string', 'example' => 'xxxxxx-xxxxx-xxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"10050008\\\\n\\",\\n \\"Message\\": \\"这个一个错误消息。\\\\n\\",\\n \\"Data\\": {\\n \\"TaskUuid\\": \\"xxxxxx-xxxxx-xxxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'Submit a video synthesis job ', 'description' => 'Use this API to customize video synthesis styles. For standard video synthesis tasks, use one of the following: Submit 3D Text-to-Video Synthesis Task, Submit 3D Speech-to-Video Synthesis Task, Submit 2D Text-to-Video Synthesis Task, or Submit 2D Speech-to-Video Synthesis Task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitToAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitTextTo2DAvatarVideoTask' => [ 'summary' => 'Submit a job to generate a 2D digital human video offline based on a piece of text. This API immediately returns a TaskUuid as the unique ID for the submitted job. You can later use this TaskUuid to invoke the query and cancel job APIs.'."\n", 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar74USDX'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID, obtained from the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Developer application information, representing a business configuration '."\n", 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. Obtain the corresponding appId from the Developer Center > Instance Management page. See [References](https://help.aliyun.com/document_detail/479093.html?spm=a2c4g.447644.0.0.406f66c95dI2Ee#6a48daa1ee899). ', 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The title of the submitted video synthesis job. The title can contain up to 64 characters.', 'type' => 'string', 'required' => true, 'example' => '这是一个示例标题', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'Input text for synthesis. Maximum length: 1000 characters. Supports SSML for specifying TTS pronunciation of polyphonic characters, pauses, special readings, etc. For details, see: [2D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/448147.html).', 'type' => 'string', 'required' => true, 'example' => '这是一个示例文本', 'title' => ''], ], [ 'name' => 'VideoInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Video configuration.', 'type' => 'object', 'properties' => [ 'IsAlpha' => ['description' => 'Whether to enable the alpha channel. Default value: false. '."\n" .'- true: Enables the alpha channel. The video format can be specified via AlphaFormat and supports webm, mov, or mp4. '."\n" .'- false: Disables the alpha channel. The video format is mp4.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], 'AlphaFormat' => [ 'description' => 'Alpha channel format. Default value: 1. '."\n" .'- 1: webm '."\n" .'- 2: mov '."\n" .'- 3: mp4 '."\n" ."\n" .'>When isAlpha is false, this field is ignored. Transparent videos in mov format result in very large file sizes and are not recommended. Use webm or mp4 instead. '."\n" .'>Some 2D photorealistic digital humans do not support transparent video formats. Currently, official platform digital humans support transparent output. For custom avatars, transparency depends on the selection made during customization.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'enum' => [], 'required' => false, 'example' => '1', 'title' => '', ], 'IsSubtitles' => ['description' => 'Specifies whether to generate captions. Default value: true.'."\n" ."\n" .'- true: Captions are generated in the ASS file format and provided as a separate subtitle file with a download link.'."\n" .'- false: Captions are not generated.'."\n" ."\n" .'>This field is deprecated. Regardless of whether you set this field to true or false, a separate subtitle file is always generated. Use the SubtitleEmbedded field to control whether captions are merged into the video.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'deprecated' => true, 'title' => ''], 'SubtitleEmbedded' => ['description' => 'Specifies whether to merge captions into the video. Default value: false.'."\n" ."\n" .'- true: Captions are merged into the video.'."\n" .'- false: Captions are not merged into the video.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'BackgroundImageUrl' => ['description' => 'A valid and accessible URL of the background image.'."\n" ."\n" .'The resolution of the background image must match the resolution of the generated video.'."\n" ."\n" .'Supported image formats include JPG, JPEG, and PNG.', 'type' => 'string', 'required' => false, 'example' => '可访问的公网url地址', 'title' => ''], 'Resolution' => [ 'enumValueTitles' => [], 'description' => 'Resolution of the generated video. Different digital humans support different resolutions: '."\n" .'- 3: 1080 × 1920 (portrait) '."\n" .'- 4: 1920 × 1080 (landscape)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => '', ], 'SubtitleStyle' => [ 'description' => 'Caption style.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'Font name. Default value: alibabapuhuiti.', 'type' => 'string', 'required' => false, 'example' => 'alibabapuhuiti', 'title' => ''], 'Color' => ['description' => 'Font color, in hexadecimal RGBA format.', 'type' => 'string', 'required' => false, 'example' => '#000000FF', 'title' => ''], 'OutlineColor' => ['description' => 'Outline color, in hexadecimal RGBA format.', 'type' => 'string', 'required' => false, 'example' => '#FFFFFF00', 'title' => ''], 'Y' => ['description' => 'Y-axis position of the caption. The top of the frame has a coordinate of 0. Default values: 984 for 1920×1080 resolution, 1824 for 1080×1920 resolution.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '984', 'title' => ''], 'Size' => ['description' => 'Font size. Minimum value: 36, maximum value: 72, default value: 36.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '36', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AudioInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Audio-related configuration. If not provided, the default value configured in the asset will be used. ', 'type' => 'object', 'properties' => [ 'Voice' => ['description' => 'The speaker code for TTS voice. Obtain it from the 2D Asset Management page of the Digitized Virtual Human Open Platform. If not specified, the speaker configured in the asset is used.', 'type' => 'string', 'required' => false, 'example' => 'guijie', 'title' => ''], 'SpeechRate' => ['description' => 'The speech rate of the TTS voice. Value range: -500 to 500. If not specified, the default value configured in the asset is used.'."\n" ."\n" .'The values [-500, 0, 500] correspond to speech rate multipliers in the range [0.5, 1.0, 2.0]:'."\n" ."\n" .'-500 represents 0.5× the base speech rate; '."\n" .'0 represents 1.0× the base speech rate. The base rate refers to the model\'s default synthesized speech speed, which varies slightly by speaker and is approximately four Chinese characters per second; '."\n" .'500 represents 2.0× the base speech rate.'."\n" ."\n" .'The calculation method is as follows:'."\n" ."\n" .'For 0.8× speed: (1 - 1/0.8) / 0.002 = -125 '."\n" .'For 1.2× speed: (1 - 1/1.2) / 0.001 = 166', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '-500', 'example' => '0', 'title' => ''], 'Volume' => ['description' => 'The volume of the TTS voice. Value range: 0 to 100. If not specified, the default value configured in the asset is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '50', 'title' => ''], 'PitchRate' => ['description' => 'The pitch rate of the TTS voice. Value range: -500 to 500. If not specified, the default value configured in the asset is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '-500', 'example' => '0', 'title' => ''], 'SampleRate' => [ 'enumValueTitles' => [16000 => '16000', 24000 => '24000', 48000 => '48000'], 'description' => 'The output audio sampling rate (unit: Hz).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16000', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AvatarInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Configuration related to the digital human appearance.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The code of the digital human avatar, which can be obtained from the 2D Assets page of the Digitized Virtual Human Open Platform. If this parameter is not specified, the default avatar configured in the application is used.', 'type' => 'string', 'required' => false, 'example' => 'CH_xxxxx', 'title' => ''], 'X' => ['description' => 'The horizontal pixel offset of the digital human layer relative to the top-left corner of the screen. The default value in the original state is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Y' => ['description' => 'The vertical pixel offset of the digital human layer relative to the top-left corner of the screen. The default value in the original state is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Width' => ['description' => 'The width of the digital human layer.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '数字人底板视频为横屏：1920'."\n" .'数字人底板视频为竖屏：1080', 'title' => ''], 'Height' => ['description' => 'The height of the digital human layer.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '数字人底板视频为横屏：1080'."\n" .'数字人底板视频为竖屏：1920', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable management event callbacks for this video synthesis job. The default value is false, which means no callback. The platform supports callbacks at the start and end of a job. For more information, see the document: [Digital Human Callback Event Notifications](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.447644.0.0.406f5876hRJTVU).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CallbackParams', 'in' => 'query', 'schema' => ['description' => 'Additional parameters to pass through during the callback, provided as a JSON-formatted string. This parameter takes effect only when callback=true.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xxx": "xxx"'."\n" .'}', 'title' => ''], ], [ 'name' => 'ExtParams', 'in' => 'query', 'schema' => ['description' => 'Some extension parameters.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xxx": "xxx"'."\n" .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Code' => ['title' => 'Id of the request', 'description' => 'Error code ', 'type' => 'string', 'example' => '-10000000'], 'Message' => ['description' => 'Error message ', 'type' => 'string', 'example' => '这个一次错误消息。', 'title' => ''], 'Data' => [ 'description' => 'Result data of the invocation ', 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'Unique UUID of the job, used later to query job details. Please store it securely. ', 'type' => 'string', 'example' => 'xxxx-xxx-xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"-10000000\\",\\n \\"Message\\": \\"这个一次错误消息。\\",\\n \\"Data\\": {\\n \\"TaskUuid\\": \\"xxxx-xxx-xxx\\"\\n }\\n}","type":"json"}]', 'title' => 'Submit a 2D Text-to-Video Synthesis Job ', 'description' => 'Submit a job to generate a 2D digital human video offline based on a piece of text. This API immediately returns a TaskUuid as the unique ID for the submitted job. You can subsequently use the TaskUuid to call the [Query Video Synthesis Job Details](https://help.aliyun.com/document_detail/447640.html) API to check the status of the corresponding job. When the job status is "Succeeded," you can obtain the download URL for the generated video and proceed with the download. If the job status is "Not Started," you can also use the TaskUuid to call the [Cancel Video Synthesis Job](https://help.aliyun.com/document_detail/447642.html) API to cancel the job.'."\n" ."\n" .'> Refer to the [2D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/448147.html?spm=a2c4g.447834.0.0.13666d79MiKZX4) for the complete integration flow of 2D video synthesis.'."\n", 'responseParamsDescription' => 'TaskUuid is the unique identifier of the job. Please store it securely.'."\n", 'changeSet' => [ ['createdAt' => '2024-01-08T10:31:36.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-08T08:42:05.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-14T06:13:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-01T09:10:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-06-25T03:13:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-07T01:42:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-05-12T02:56:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-30T08:01:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-25T08:33:06.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-25T03:00:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-24T07:48:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-18T11:19:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitTextTo2DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitTextTo3DAvatarVideoTask' => [ 'summary' => 'Submit a job to offline generate a 3D digital human video based on a piece of text. This API immediately returns a TaskUuid as the unique identifier for the submitted job. You can later use this TaskUuid to invoke the query and cancel job APIs.'."\n", 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatar74USDX', 'FEATUREavatar9FRZ6U'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'Tenant ID, obtained from the digitized virtual human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'App information, representing a business configuration'."\n", 'type' => 'object', 'properties' => [ 'AppId' => ['description' => 'App ID. Obtain the corresponding appId on the Developer Center > Instance Management page. See [References](https://help.aliyun.com/document_detail/479093.html?spm=a2c4g.447644.0.0.406f66c95dI2Ee#6a48daa1ee899).'."\n", 'type' => 'string', 'required' => true, 'example' => '3d95xx946a', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'Title of the submitted video synthesis job. The title can contain up to 64 characters. ', 'type' => 'string', 'required' => true, 'example' => '这是一个示例标题', 'title' => ''], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => ['description' => 'The text to synthesize. It can contain up to 1,000 characters. SSML is supported to specify TTS pronunciation for polyphonic characters, pauses, special readings, digital human actions, and more. For details, see [3D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/447834.html). ', 'type' => 'string', 'required' => true, 'example' => '这是一个示例文本', 'title' => ''], ], [ 'name' => 'VideoInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Video format ', 'type' => 'object', 'properties' => [ 'IsAlpha' => [ 'description' => 'Whether the alpha channel is required. Default value: false. '."\n" .'- true: Enables the alpha channel. The video format can be specified by AlphaFormat and supports WebM, MOV, and MP4. '."\n" .'- false: Disables the alpha channel. The video format is MP4. ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'enumValueTitles' => ['true' => '透明', 'false' => '不透明'], 'title' => '', ], 'AlphaFormat' => [ 'description' => 'Alpha channel format. Default value: 1. '."\n" .'- 1: webm '."\n" .'- 2: mov '."\n" .'- 3: mp4'."\n" ."\n" .'>When isAlpha is false, this field is ignored. MOV format transparent video files result in very large file sizes and are not recommended. Use WebM or MP4 instead.>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'enum' => [], 'enumValueTitles' => [1 => 'webm', 'mov', 'mp4'], 'title' => '', ], 'IsSubtitles' => ['description' => 'Specifies whether to generate captions. Default value: true '."\n" .'- true: Captions are generated in **ASS** file format and provided as a separate subtitle file with a download link '."\n" .'- false: Captions are not generated '."\n" ."\n" .'>This field is deprecated. Regardless of whether true or false is specified, a separate subtitle file will always be generated. Use the SubtitleEmbedded field to control whether captions are merged into the video. ', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'default' => 'true', 'deprecated' => true, 'title' => ''], 'SubtitleEmbedded' => [ 'enumValueTitles' => ['true' => 'Captions merged into video ', 'false' => 'Captions not merged into video '], 'description' => 'Specifies whether to merge captions into the video. Default value: false '."\n" .'- true: Captions are merged into the video '."\n" .'- false: Captions are not merged into the video ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => '', ], 'Resolution' => [ 'description' => 'The resolution of the generated video. The following options are currently supported: '."\n" .'- 1: 720 × 1280 (portrait) '."\n" .'- 2: 1280 × 720 (landscape) '."\n" .'- 3: 1080 × 1920 (portrait) '."\n" .'- 4: 1920 × 1080 (landscape) ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'enumValueTitles' => [1 => '720 * 1280（竖屏）', '1280 * 720（横屏）', '1080 * 1920（竖屏）', '1920 * 1080（横屏）'], 'title' => '', ], 'BackgroundImageUrl' => ['description' => 'A valid and accessible URL for the background image. The resolution of the background image must match the resolution of the generated video. '."\n" .'- Currently supported image formats are JPG, JPEG, and PNG.', 'type' => 'string', 'required' => false, 'example' => '可访问的公网url地址', 'title' => ''], 'SubtitleStyle' => [ 'description' => 'Caption style.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'Font name. Default value: alibabapuhuiti.', 'type' => 'string', 'required' => false, 'example' => 'alibabapuhuiti', 'title' => ''], 'Color' => ['description' => 'Font color, specified as a hexadecimal RGBA color code.', 'type' => 'string', 'required' => false, 'example' => '#000000FF', 'title' => ''], 'OutlineColor' => ['description' => 'Outline color, specified as a hexadecimal RGBA color code.', 'type' => 'string', 'required' => false, 'example' => '#FFFFFF00', 'title' => ''], 'Y' => ['description' => 'Y-axis position of the caption. The top of the frame has a coordinate of 0. Default values: 984 for 1920×1080 resolution, and 1824 for 1080×1920 resolution.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '984', 'title' => ''], 'Size' => ['description' => 'Font size. Minimum value: 36. Maximum value: 72. Default value: 36.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '36', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AvatarInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Configuration related to the digital human.', 'type' => 'object', 'properties' => [ 'Locate' => ['description' => 'Digital human camera shot '."\n" .'- 0: Full-body close-up (default shot) '."\n" .'- 1: Head close-up '."\n" .'- 2: Full-body long shot '."\n" .'- 3: Upper-body close-up '."\n" .'- 4: Upper-body long shot '."\n" .'- 5: Left-side close-up '."\n" .'- 6: Right-side close-up '."\n" ."\n" .'For a preview of the visual effect of each camera shot, see: [3D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/447834.html#9c8a96707515k) ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Angle' => ['description' => 'The viewing angle of the digital human:'."\n" ."\n" .'- 0: Front view (default)'."\n" .'- 1: 30 degrees to the left'."\n" .'- 2: 30 degrees to the right'."\n" ."\n" .'For previews of each angle, see: [3D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/447834.html#a989eb5075t9y)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Code' => ['description' => 'Character code ', 'type' => 'string', 'required' => false, 'example' => 'CH_xxxxxxx', 'title' => ''], 'IndustryCode' => ['description' => 'Industry code. Default value: default.'."\n" ."\n" .'- default – General purpose (default)'."\n" .'- kefu – Customer service industry'."\n" .'- live – Live streaming scenario', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'AudioInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Audio-related configuration. If not provided, the default value configured in the asset will be used. '."\n" .'> Some voice styles from Alibaba Cloud speech synthesis have not been validated for quality and may result in perceptible differences.'."\n", 'type' => 'object', 'properties' => [ 'Voice' => ['description' => 'The speaker code for TTS voice. Obtain it from the 3D Asset Management page of the digitized virtual human Open Platform. If not specified, the speaker configured in the asset is used.', 'type' => 'string', 'required' => false, 'example' => 'guijie', 'title' => ''], 'SpeechRate' => ['description' => 'The speech rate of the TTS voice. Valid values: -500 to 500. If not specified, the default value configured in the asset is used.'."\n" ."\n" .'The speech rate values [-500, 0, 500] correspond to speed multipliers [0.5, 1.0, 2.0], respectively.'."\n" ."\n" .'- -500 represents 0.5× the base speech rate.'."\n" .'- 0 represents 1.0× the base speech rate. The base rate is the model\'s default synthesized speech speed, which varies slightly by speaker and is approximately four Chinese characters per second.'."\n" .'- 500 represents 2.0× the base speech rate.'."\n" ."\n" .'The calculation method is as follows:'."\n" ."\n" .'For 0.8× speed: (1 - 1/0.8) / 0.002 = -125 '."\n" .'For 1.2× speed: (1 - 1/1.2) / 0.001 = 166', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'Volume' => ['description' => 'The volume of the TTS voice. Valid values: 0 to 100. If not specified, the default value configured in the asset is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'PitchRate' => ['description' => 'The pitch of the TTS voice. Valid values: -500 to 500. If not specified, the default value configured in the asset is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'SampleRate' => [ 'enumValueTitles' => [16000 => '16000', 24000 => '24000', 48000 => '48000'], 'description' => 'The sample rate of the output audio (unit: Hz).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16000', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable management event callbacks for this video synthesis job. The default value is false, which disables callbacks. The platform supports callbacks at job start and job end. For more information, see [Digital Human Callback Event Notifications](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.447644.0.0.406f5876hRJTVU). ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'CallbackParams', 'in' => 'query', 'schema' => ['description' => 'Parameters to be passed through during callback, provided as a JSON-formatted string. This parameter takes effect only when callback=true. ', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "xxx": "xxx"'."\n" .'}', 'title' => ''], ], [ 'name' => 'ExtParams', 'in' => 'query', 'schema' => ['description' => 'Extended parameters. ', 'type' => 'string', 'required' => false, 'example' => '{"xxx": "xxx"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID'."\n", 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Code' => ['description' => 'Error code'."\n", 'type' => 'string', 'example' => '502', 'title' => ''], 'Message' => ['description' => 'Error message'."\n", 'type' => 'string', 'example' => '这是一个错误', 'title' => ''], 'Data' => [ 'description' => 'Returned data from the invocation'."\n", 'type' => 'object', 'properties' => [ 'TaskUuid' => ['description' => 'Unique UUID of the job, used later to query job details. Please store it securely.'."\n", 'type' => 'string', 'example' => 'xxxxxx-xxxxx-xxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"502\\",\\n \\"Message\\": \\"这是一个错误\\",\\n \\"Data\\": {\\n \\"TaskUuid\\": \\"xxxxxx-xxxxx-xxxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'Submit a 3D Text-to-Video Synthesis Job'."\n", 'description' => 'Submit a job to offline generate a 3D digital human video based on a piece of text. This API immediately returns a TaskUuid as the unique identifier for the submitted job. You can subsequently use this TaskUuid to invoke the [Query Video Synthesis Job Details](https://help.aliyun.com/document_detail/447640.html) API to check the job status. When the job status is "Succeeded," you can obtain the download URL for the corresponding video and download it. If the job status is "Not Started," you can also use the TaskUuid to invoke the [Cancel Video Synthesis Job](https://help.aliyun.com/document_detail/447642.html) API to cancel the job.'."\n" ."\n" .'> Refer to the [3D Digital Human Video Synthesis User Guide](https://help.aliyun.com/document_detail/447834.html?spm=a2c4g.446838.0.0.54a96d79OAZR9X) for the complete integration flow of 3D video synthesis.'."\n", 'responseParamsDescription' => 'TaskUuid is the unique identifier of this job. Please store it securely.'."\n", 'changeSet' => [ ['createdAt' => '2024-01-08T10:31:36.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-08T08:42:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-01T09:10:39.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-05T02:23:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-30T08:01:28.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-29T07:35:56.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-04T02:16:06.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-18T11:19:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitTextTo3DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Update2dAvatar' => [ 'summary' => 'Updates a 2D custom avatar. You cannot modify an avatar while it is being created.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREavatarM637C1'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TenantId', 'in' => 'query', 'schema' => ['description' => 'The tenant ID. Get this ID from the developer information section of your business configuration on the Digitized Virtual Human Open Platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9185', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The avatar code.', 'type' => 'string', 'required' => true, 'example' => 'CH_2d_xxxxxx'."\n", 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The character name.', 'type' => 'string', 'required' => false, 'example' => '博远', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The character description.', 'type' => 'string', 'required' => false, 'example' => '朝气蓬勃，富有感染力，适用于播音、传媒广电、企业宣传等场景', 'title' => ''], ], [ 'name' => 'Image', 'in' => 'query', 'schema' => ['description' => 'The character thumbnail.'."\n" ."\n" .'- If you do not provide a thumbnail, the first frame of the video is used as the thumbnail.'."\n" ."\n" .'- If you provide a thumbnail, its resolution must match the source video. The image must be in PNG format and smaller than 10 MB.', 'type' => 'string', 'required' => false, 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", 'title' => ''], ], [ 'name' => 'Portrait', 'in' => 'query', 'schema' => ['description' => 'The character\'s profile picture. If you do not provide a profile picture, the existing one is not updated.'."\n" ."\n" .'\\- Requirements: 1:1 aspect ratio, PNG format, and a size smaller than 10 MB.', 'type' => 'string', 'required' => false, 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.png?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", 'title' => ''], ], [ 'name' => 'Video', 'in' => 'query', 'schema' => ['description' => 'The URL of the source video material. You can only update the video for roles that failed to be created. Requirements:'."\n" ."\n" .'- Format: MOV, WebM, or MP4'."\n" ."\n" .'- Duration: 3 to 8 minutes'."\n" ."\n" .'- Resolution: 1080p'."\n" ."\n" .'- Size: smaller than 10 GB', 'type' => 'string', 'required' => false, 'example' => 'https://virtual-human-assets.oss-cn-beijing.aliyuncs.com/2d_assets/xxx/xxx/xxx.mov?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", 'title' => ''], ], [ 'name' => 'Transparent', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the source video has a transparent background.'."\n" ."\n" .'- true: The video has a transparent background. The background can be replaced in the future.'."\n" ."\n" .'- false: The video does not have a transparent background. The background cannot be replaced.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Orientation', 'in' => 'query', 'schema' => ['description' => 'The orientation of the source video.'."\n" ."\n" .'- 1: Portrait'."\n" ."\n" .'- 2: Landscape', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to receive event callbacks for the success or failure of this 2D avatar generation task. The default value is false, which means no callbacks are sent. For more information, see [Digital Human Callback Notifications](https://help.aliyun.com/document_detail/2261152.html?spm=a2c4g.447644.0.0.406f5876hRJTVU).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7'."\n"], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '10010001', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '这是一个错误', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Data' => [ 'description' => 'The data returned from the call.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The avatar code.', 'type' => 'string', 'example' => 'CH_2d_xxxxxx'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\\\\n\\",\\n \\"Code\\": \\"10010001\\",\\n \\"Message\\": \\"这是一个错误\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Code\\": \\"CH_2d_xxxxxx\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'Update 2D Custom Avatar Creation Job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:Update2dAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/{#AssetId}'], ], ], ], ], ], ], 'endpoints' => [ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'avatar.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'avatar.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'avatar-vpc.cn-zhangjiakou.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'MissingAppId', 'message' => 'AppId is mandatory for this action.', 'http_code' => 400, 'description' => 'AppId is a required field'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryAvatar'], ['description' => 'Response parameters changed', 'api' => 'QueryAvatarList'], ], 'createdAt' => '2024-02-26T06:54:40.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'StartInstance'], ], 'createdAt' => '2024-01-24T07:05:56.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2024-01-08T10:31:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitAudioTo2DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitAudioTo3DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2024-01-08T08:42:13.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitAudioTo2DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], 'createdAt' => '2023-12-14T06:13:23.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'StartInstance'], ], 'createdAt' => '2023-11-08T09:38:36.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryRunningInstance'], ], 'createdAt' => '2023-10-30T11:28:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetVideoTaskInfo'], ['description' => 'Response parameters changed', 'api' => 'QueryVideoTaskInfo'], ], 'createdAt' => '2023-10-24T02:34:06.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryVideoTaskInfo'], ], 'createdAt' => '2023-08-28T08:18:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetVideoTaskInfo'], ], 'createdAt' => '2023-08-28T07:38:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryAvatar'], ['description' => 'Response parameters changed', 'api' => 'QueryAvatarList'], ], 'createdAt' => '2023-08-28T02:13:38.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetVideoTaskInfo'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitAudioTo2DAvatarVideoTask'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitAudioTo3DAvatarVideoTask'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2023-08-01T09:10:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryAvatar'], ['description' => 'Response parameters changed', 'api' => 'QueryAvatarList'], ], 'createdAt' => '2023-07-28T03:35:23.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitAudioTo3DAvatarVideoTask'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2023-07-05T02:24:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitAudioTo2DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitAudioTo3DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], 'createdAt' => '2023-06-25T03:13:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendMessage'], ], 'createdAt' => '2023-06-13T03:18:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetVideoTaskInfo'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], 'createdAt' => '2023-06-07T01:42:28.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], 'createdAt' => '2023-05-12T02:56:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendMessage'], ], 'createdAt' => '2023-05-10T07:28:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetVideoTaskInfo'], ], 'createdAt' => '2023-03-24T08:24:13.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetVideoTaskInfo'], ], 'createdAt' => '2022-12-22T06:05:21.000Z', 'description' => '离线人物查询返回增加failCode', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetVideoTaskInfo'], ['description' => 'Response parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2022-11-30T08:01:45.000Z', 'description' => '修改接口返回值类型', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2022-11-29T07:38:02.000Z', 'description' => '1、离线3d视频支持多机位多角度2、透明视频支持用户选择webm、mov格式', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], 'createdAt' => '2022-11-25T08:34:23.000Z', 'description' => '去除部分不需要的默认值', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], 'createdAt' => '2022-11-25T03:01:52.000Z', 'description' => '优化错误信息展示', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ], 'createdAt' => '2022-11-24T07:50:09.000Z', 'description' => '2D数字人支持设置人物code，声音和背景图', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2022-11-04T02:17:02.000Z', 'description' => '离线pass增加背景图片', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'QueryRunningInstance'], ], 'createdAt' => '2022-09-21T03:25:38.000Z', 'description' => 'QueryRunningInstance新增支持查询指定sessionId的实例运行信息', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'StartInstance'], ], 'createdAt' => '2022-08-25T08:52:06.000Z', 'description' => '启动数字人增加透明通道的支持', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CancelVideoTask'], ['description' => 'Request parameters changed', 'api' => 'GetVideoTaskInfo'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ], 'createdAt' => '2022-08-18T11:42:34.000Z', 'description' => '离线合成能力发布。', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SubmitTextToSignVideoTask'], ], 'createdAt' => '2022-08-17T09:59:46.000Z', 'description' => '1. 发布“3D文本离线合成”产品能力。2. 发布”2D文本离线合成“产品能力。3. 发布”异步离线合成任务管理“产品能力。 * 任务详情获取。 * 取消任务。', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'StartInstance'], ], 'createdAt' => '2022-08-05T07:54:38.000Z', 'description' => 'startInstance接口增加返回参数token，在调用对话互动时作为入参', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendMessage'], ], 'createdAt' => '2022-07-28T07:17:19.000Z', 'description' => '支持AvatarUI协议支持RTMP推流', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'QueryRunningInstance'], ], 'createdAt' => '2022-07-27T05:03:32.000Z', 'description' => '新增查询指定应用下的运行中的数字人实例（启动一个数字人API创建的实例）的API。', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendMessage'], ], 'createdAt' => '2022-05-10T11:41:55.000Z', 'description' => '升级avatar sdk，支持文本播报过程中打断上一次播报', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendMessage'], ['description' => 'Request parameters changed', 'api' => 'StartInstance'], ['description' => 'Request parameters changed', 'api' => 'StopInstance'], ], 'createdAt' => '2022-03-02T09:58:11.000Z', 'description' => '接口初始化', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CompleteCommodity'], ['description' => 'OpenAPI offline', 'api' => 'CompleteOrderParam'], ['description' => 'OpenAPI offline', 'api' => 'PayOrderCallback'], ['description' => 'OpenAPI offline', 'api' => 'Refund'], ['description' => 'OpenAPI offline', 'api' => 'Verify'], ], 'createdAt' => '2022-03-02T06:08:36.000Z', 'description' => '云上数字人平台商业化spi接口发布', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SendMessage'], ['description' => 'OpenAPI offline', 'api' => 'StartInstance'], ['description' => 'OpenAPI offline', 'api' => 'StopInstance'], ], 'createdAt' => '2022-03-01T16:05:10.000Z', 'description' => '开放平台接口初始化', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'StartInstance'], ], 'createdAt' => '2022-03-01T16:04:12.000Z', 'description' => '初始化', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LicenseAuth'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DuplexDecision'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAudioTo3DAvatarVideoTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartTimedResetOperate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseTimedResetOperate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVideoTaskInfo'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTextTo3DAvatarVideoTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendMessage'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTimedResetOperateStatus'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAvatarList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitAudioTo2DAvatarVideoTask'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitTextTo2DAvatarVideoTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelVideoTask'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRunningInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAvatar'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartInstance'], ], ], 'ram' => [ 'productCode' => 'Avatar', 'productName' => 'digitized virtual human', 'ramCodes' => ['avatar'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'QueryVideoTaskInfo', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'avatar:QueryVideoTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryAvatarList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'avatar:QueryAvatarList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar:*:{#accountId}:asset/*'], ], ], ], [ 'apiName' => 'ConfirmAvatar2dTrain', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ConfirmAvatar2dTrain', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SendMessage', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Update2dAvatar', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:Update2dAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/{#AssetId}'], ], ], ], [ 'apiName' => 'StopInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:StopInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitAvatarVideoTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitToAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CloseTimedResetOperate', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:CloseTimedResetOperate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteAvatar', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:DeleteAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/{#AssetId}'], ], ], ], [ 'apiName' => 'StartInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:StartInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitAudioTo3DAvatarVideoTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitAudioTo3DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ClientStart', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ClientStart', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'StartTimedResetOperate', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:StartTimedResetOperate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SendText', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Create2dAvatar', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:Create2dAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/*'], ], ], ], [ 'apiName' => 'SubmitTextTo2DAvatarVideoTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitTextTo2DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryAvatar', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:QueryAvatar', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/{#AssetId}'], ], ], ], [ 'apiName' => 'Render3dAvatar', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:Render3dAvatar', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DuplexDecision', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:DuplexDecision', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryRunningInstance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:QueryRunningInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitTextTo3DAvatarVideoTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitTextTo3DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitAudioTo2DAvatarVideoTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SubmitAudioTo2DAvatarVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ClientAuth', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ClientAuth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelVideoTask', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'avatar:CancelVideoTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SendCommand', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendCommand', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SendVaml', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'avatar:SendVaml', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'LicenseAuth', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:LicenseAuth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ClientUnbindDevice', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'avatar:ClientUnbindDevice', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryTimedResetOperateStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:QueryTimedResetOperateStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetVideoTaskInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'avatar:GetVideoTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Avatar', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'Asset', 'arn' => 'acs:avatar:*:{#accountId}:asset/*'], ['validationType' => 'always', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/{#AssetId}'], ['validationType' => 'always', 'resourceType' => 'Asset', 'arn' => 'acs:avatar::{#accountId}:asset/*'], ], ], ];