# Platform Capabilities

The platform provides various algorithmic capabilities for enterprise accounts, including: video synthesis, avatar model generation, TTS personal voice model generation, avatar model update, video face swap, and more.

# API Reference

To call all API services on the platform, users must access the service endpoint: aigc.softsugar.com, and include the token information in the request header.

# Create Video Face Swap Task (Internal Testing)

# 接口Description

Invokes algorithmic capabilities based on user-uploaded video content and template images for video face swap processing, ultimately returning processed video files and thumbnails for user download.

# Request URL

POST /api/2dvh/v1/material/face/swap/create

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`facePhotoUrl`	String	True	Template face image used for face swap
`videoUrl`	String	True	Original video file used for face swap
`materialName`	String	True	Face swap task name

# Request Example

{
  "facePhotoUrl": "facePhotoUrl",
  "videoUrl": "videoUrl",
  "materialName": "materialName"

}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task ID

# Response Example

{
  "code": 0,
  "message": "success",
  "data": 1
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task ID

# Response Example

{
    "code": 0,
    "message": "success",
    "data": 1
}

# Content Preheating (For Filler Speech/Broadcast Scripts) (For Live Streaming Scenarios)

# 接口Description

For filler speech and broadcast script scenarios, text/voice requests are made in advance to obtain an ID that can be used directly when starting the live stream, improving broadcast start/response speed in live streaming scenarios.

# Request URL

POST /api/2dvh/v1/material/voice/content/repository/create

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`materialName`	String	True	Quick Q&A library name
`param`	String	True	Quick Q&A library JSON. Please refer to the parameter descriptions and JSON examples below
`thumbnailUrl`	String	False	Thumbnail URL

# param Parameter Description

Field	Type	Required	Description
`type`	String	True	需填值"quick_response"或"startup_script"。 "quick_response"表示在互动Digital human场景中的口水话功能中使用。 "startup_script"表示在直播场景中的开播脚本中使用。
`desc`	String	False	Description
`digital_role`	Object	False	Digital human
- `face_feature_id`	String	True	Digital humanface feature id
- `name`	String	True	Digital humanName
`tts_config`	Object	True	TTS configuration
- `qid`	String	False	Required when text is present
- `name`	String	False	发音人Name
- `pitch_offset`	Float	False	Pitch. Higher values are sharper, lower values are deeper. Range [-60, 60]
- `speed_ratio`	Float	False	Speech rate. Higher values mean slower speech. Range [0.5, 2]
- `volume`	Integer	False	Volume. Higher values mean louder. Range [1, 400]
`voice_content`	Array	True	适用于Digital human脚本和口水词的文本及音频预热。
- `tts_query`	Object	False	预热内容的请求文本。TTS文本和音频文件只支持一个，同时存在时TTS优先。预热内容要么全部是TTS请求，要么全部是音频请求，不能混用。
- - `content`	String	False	Text content of the preheated content
- - `ssml`	Boolean	False	Whether to use SSML request
- `audio`	String	False	预热内容的音频接管文件地址。TTS文本和音频文件只支持一个，同时存在时TTS优先。预热内容要么全部是TTS请求，要么全部是音频请求，不能混用。

# Request Example

{
  "materialName": "534",
  "url": "https://xxx/materials/33/demo_20230228104258028_20230720185601860.jpg",
  "param": "{\"type\":\"quick_response\",\"desc\":\"123\",\"digital_role\":{\"face_feature_id\":\"1510a3ae060e4d7ea523684eb72b3447_s1test\",\"name\":\"小李\"},\"tts_config\":{\"qid\":\"EAdUVf:AEA_Z10Mqp9GYwDGPMTSiszE7NKMqrCg\",\"name\":\"xiaoxuan\",\"pitch_offset\":0,\"speed_ratio\":1,\"volume\":400},\"voice_content\":[{\"tts_query\":{\"content\":\"感谢你的提问，这个问题我想一下回答你。\",\"ssml\":false},\"audio\":\"\"},{\"tts_query\":{\"content\":\"这是一个好问题，我需要仔细思考一下，才能给出一个准确的答案。\",\"ssml\":false},\"audio\":\"\"},{\"tts_query\":{\"content\":\"好的，这位同学，请稍等。\",\"ssml\":false}}]}"
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task ID

# Response Example

{
  "code": 0,
  "message": "success",
  "data": 1
}

# Material Preheating - FileId Preheating (For Foreground, Background, Digital Human Resources) (For Live Streaming & Video Live Streaming Scenarios)

# 接口Description

Users can upload video synthesis materials to the PaaS platform in advance through this API. The platform performs material preheating to improve video synthesis speed.

Note: Cancellation and regeneration are currently not supported.

# Request URL

POST /api/2dvh/v1/material/file/warming

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`materialName`	String	True	Material preheating task name
`param`	String	True	Material preheating task JSON is an array of preheating content. Please refer to the parameter descriptions and JSON examples below

# param Parameter Description

Field	Type	Required	Description
`fileId`	String	True	Material file ID
`fileUrl`	String	True	Material file URL

# Request Example

{
  "materialName": "XX场景预热",
  "param": "[{\"fileId\":\"9b158cc9-8e42-4d09-b928-49dd9941d921\",\"fileUrl\":\"https://xxx/xxx.png\"},{\"fileId\":\"9b158cc9-8e42-4d09-b928-49dd9941d922\",\"fileUrl\":\"https://xxx/xxx.jpg\"}]"
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task ID

# Response Example

{
  "code": 0,
  "message": "success",
  "data": 134
}

# Material Preheating - FileId Query

# 接口Description

Users can query the status of target preheated files by file ID list through this API

# Request URL

GET /api/2dvh/v1/material/file/warming/query

# Request Parameters

Field	Type	Required	Description
`fileIds`	List	True	List of fileIds of preheated files to query

# Request Example

https://xxx/api/2dvh/v1/material/file/warming/query?fileIds=20250526-dev1,20250526-dev2

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Array	False	Preheated file information list; specific structure is preheating details

# Preheated File Details

Field	Type	Required	Description
`owner`	long	True	Owner of the preheated file
`taskId`	String	True	Preheated file task ID
`fileId`	String	True	Preheated file ID
`fileUrl`	String	True	Preheated file URL
`status`	Integer	True	Status 0: Not started, 1: Waiting, 2: In progress, 5: Completed, 9: Error

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "owner": 142,
      "taskId": 2040,
      "fileId": "20250526-dev1",
      "fileUrl": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com//download/14/6b7414420aed40d3bf14111b62a749ec/video.mp4",
      "status": 5
    },
    {
      "owner": 142,
      "taskId": 2042,
      "fileId": "20250526-dev2",
      "fileUrl": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com//download/14/6b7414420aed40d3bf14111b62a749ec/video.mp4",
      "status": 2
    }
  ]
}

# Material Preheating - FileId Deletion

# 接口Description

Users can delete materials that have been preheated in the data center through this API.

# Request URL

POST /api/2dvh/v1/material/file/warming/del

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`fileIds`	List	True	List of fileIds of preheated files to delete

# Request Example

{
  "fileIds": ["9b158cc9-8e42-4d09-b928-49dd9941d921", "9b158cc9-8e42-4d09-b928-49dd9941d922"]
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task ID

# Response Example

{
  "code": 0,
  "message": "success",
  "data": 169
}

# Material Transcoding (For Video Resources) (For Live Streaming & Video Live Streaming Scenarios)

# 接口Description

Users can upload video materials to the PaaS platform in advance and perform transcoding through this API.

Note: Cancellation and regeneration are currently not supported.

# Request URL

POST /api/2dvh/v1/material/file/transcode

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`materialName`	String	True	Transcoding task name
`param`	String	True	Task JSON is a content array. Please refer to the parameter descriptions and JSON examples below

# param Parameter Description (Transcoding File Array)

Field	Type	Required	Description
`fileUrl`	String	True	Material file URL

# Request Example

{
  "materialName": "XX",
  "param": "[{\"fileUrl\":\"https://xxx/xxx.mp4\"},{\"fileUrl\":\"https://xxx/xxx.mp4\"}]"
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task ID

# Response Example

{
  "code": 0,
  "message": "success",
  "data": 134
}

# Get All Public Avatar Models

# 接口Description

Returns a paginated list of all public avatar models.

视频合成阶段需要使用的2DDigital human形象，平台提供若干个公共的2DDigital human形象模型，供用户获取后选择。具体可联系运营开通账号后查看。

# Request URL

POST /api/2dvh/v1/material/appearance/list

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`pageNo`	Integer	False	Current page number (default 1)
`pageSize`	Integer	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "pageNo": 1,
  "pageSize": 10
}

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	data object ，Usually empty on error
- `pagination`	Pagination	True	分页信息(参照共通Description)
- `result`	Array	False	Public avatar models (refer to description below)

公共人物形象模型

Field	Type	Required	Description
`id`	Long	True	Model ID
`materialName`	String	True	素材Name
`thumbnailUrl`	String	True	Thumbnail URL
`pkgUrl`	String	True	Model material package URL
`extendParam`	String	False	Avatar parameter configuration in JSON format (refer to description below)
`desc`	String	False	Notes
`createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
`updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

extendParam中人物形象模型参数信息

Field	Type	Required	Description
`faceFeatureId`	String	True	faceFeatureId，用于短视频合成和直播等场景中的ffidField
`gender`	Integer	False	Gender: 0 = Unknown, 1 = Female, 2 = Male
`avatarType`	Integer	False	Digital humanType，1为普通Digital human，2为快速Digital human，3为动静Digital human，4为动作编辑Digital human

# Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "pagination": {
                "pageNo": 1,
                "numberPages": 1,
                "numberRecords": 10,
                "pageSize": 10,
                "startIndex": 0
            },
        "result": [{
            "id": 2221738,
            "materialName": "公共人物形象1",
            "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
            "pkgUrl": "https://oss/folderPath/test_2023011312230521517.zip",
            "extendParam": "{\"faceFeatureId\": \"123\"}",
            "desc": null,
            "createTime": "2023-01-13 12:31:13",
            "updateTime": "2023-01-13 12:31:13"
        }, {
            "id": 1112226,
            "materialName": "公共人物形象2",
            "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
            "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.zip",
            "extendParam": "{\"gender\": 2, \"avatarType\": 1,\"faceFeatureId\": \"123\"}",
            "desc": null,
            "createTime": "2022-09-06 19:10:09",
            "updateTime": "2022-10-28 16:59:18"
        }]
    }
}

# Get Specified Public Avatar Models

# 接口Description

Returns a list of specified public avatar models based on input parameters.

# Request URL

POST /api/2dvh/v1/material/appearance

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`ids`	Long[]	True	Avatar model ID array

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Array	False	Usually empty on error
- `id`	Long	True	Model ID
- `materialName`	String	True	素材Name
- `thumbnailUrl`	String	True	Thumbnail URL
- `pkgUrl`	String	True	Model material package URL
- `extendParam`	String	False	Avatar parameter configuration in JSON format (refer to description below)
- `desc`	String	False	Notes
- `createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
- `updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

extendParam中人物形象模型参数信息

Field	Type	Required	Description
`faceFeatureId`	String	True	Face Feature Id
`gender`	Integer	False	Gender: 0 = Unknown, 1 = Female, 2 = Male
`avatarType`	Integer	False	Digital humanType，1为普通Digital human，2为快速Digital human，3为动静Digital human，4为动作编辑Digital human

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "公共人物形象1",
    "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
    "pkgUrl": "https://oss/folderPath/test_2023011312230521517.zip",
    "extendParam": "{\"faceFeatureId\": \"123\"}",
    "desc": null,
    "createTime": "2023-01-13 12:31:13",
    "updateTime": "2023-01-13 12:31:13"
  }, {
    "id": 16,
    "materialName": "公共人物形象2",
    "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
    "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.zip",
    "extendParam": "{\"gender\": 2, \"avatarType\": 1,\"faceFeatureId\": \"123\"}",
    "desc": null,
    "createTime": "2022-09-06 19:10:09",
    "updateTime": "2022-10-28 16:59:18"
  }]
}

# Get All Public TTS Personal Voice Models - QID

# 接口Description

Returns a paginated list of all public TTS personal voice models (QID).

Personal voice models contain speaker voice information including speech rate, pitch, volume, etc. The platform provides multiple default TTS personal voice models for users to choose from. The specified voice will be used to read the corresponding text content, and this audio will be used for video synthesis.

# Request URL

POST /api/2dvh/v3/material/tts/list

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`pageNo`	int	False	Current page number (default 1)
`pageSize`	int	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "pageNo": 1,
  "pageSize": 10
}

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	data object ，Usually empty on error
- `pagination`	Pagination	True	分页信息(参照共通Description)
- `result`	Array	False	Public TTS personal voice models (refer to description below)

公共TTS个人音色模型

Field	Type	Required	Description
`id`	Long	True	Model ID
`extendParam`	String	True	ttsConfig的Json串，记录tts参数信息（参照下面Description）
`materialName`	String	True	素材Name
`thumbnailUrl`	String	True	Thumbnail URL
`desc`	String	False	Notes
`createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
`updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

Field	Type	Required	Description
`qid`	String	True	Voice ID
`voiceName`	String	True	音色Name
`languages`	Array	True	Language
`speedRatio`	Integer	True	Speech rate
`pitchOffset`	Integer	True	Pitch
`volume`	Integer	True	Volume
`sampleUrl`	String	False	Preview URL
`gender`	Integer	False	Gender: 0 = Unknown, 1 = Female, 2 = Male

# Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 10,
      "pageSize": 10,
      "startIndex": 0
    },
    "result": [
      {
        "id": 2221738,
        "extendParam": {
          "qid": "ttsId1",
          "languages": ["zh-CN"],
          "speedRatio": 4,
          "pitchOffset": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型1",
        "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
        "desc": null,
        "createTime": "2023-01-13 12:31:13",
        "updateTime": "2023-01-13 12:31:13"
      },
      {
        "id": 1112226,
        "extendParam": {
          "qid": "ttsId2",
          "languages": ["zh-CN"],
          "speedRatio": 4,
          "pitchOffset": 1,
          "gender": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型2",
        "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
        "desc": null,
        "createTime": "2022-09-06 19:10:09",
        "updateTime": "2022-10-28 16:59:18"
      }
    ]
  }
}

# Get Specified Public TTS Personal Voice Models - QID

# 接口Description

Returns specified public TTS personal voice models (QID) based on input parameters.

# Request URL

POST /api/2dvh/v3/material/tts

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`ids`	Long[]	True	Model ID array

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Array	False	Usually empty on error
- `id`	Long	True	Model ID
- `extendParam`	String	True	ttsConfig的Json串，记录tts参数信息（参照下面Description）
- `materialName`	String	True	素材Name
- `thumbnailUrl`	String	True	Thumbnail URL
- `desc`	String	False	Notes
- `createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
- `updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

Field	Type	Required	Description
`qid`	String	True	Voice ID
`voiceName`	String	True	音色Name
`languages`	Array	True	Language
`speedRatio`	Integer	True	Speech rate
`pitchOffset`	Integer	True	Pitch
`volume`	Integer	True	Volume
`sampleUrl`	String	False	Preview URL
`gender`	Integer	False	Gender: 0 = Unknown, 1 = Female, 2 = Male

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 13,
      "extendParam": {
        "qid": "ttsId1",
        "languages": ["zh-CN"],
        "speedRatio": 4,
        "pitchOffset": 1,
        "volume": 100
      },
      "materialName": "公共角色TTS音色模型1",
      "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
      "desc": null,
      "createTime": "2023-01-13 12:31:13",
      "updateTime": "2023-01-13 12:31:13"
    },
    {
      "id": 16,
      "extendParam": {
        "qid": "ttsId2",
        "languages": ["zh-CN"],
        "speedRatio": 4,
        "pitchOffset": 1,
        "gender": 1,
        "volume": 100
      },
      "materialName": "公共TTS个人音色模型2",
      "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
      "desc": null,
      "createTime": "2022-09-06 19:10:09",
      "updateTime": "2022-10-28 16:59:18"
    }
  ]
}

# Get All Public TTS Personal Voice Models (Legacy)

# 接口Description

Returns a paginated list of all public TTS personal voice models.

# Request URL

POST /api/2dvh/v1/material/tts/list

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`pageNo`	int	False	Current page number (default 1)
`pageSize`	int	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "pageNo": 1,
  "pageSize": 10
}

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	data object ，Usually empty on error
- `pagination`	Pagination	True	分页信息(参照共通Description)
- `result`	Array	False	Public TTS personal voice models (refer to description below)

公共TTS个人音色模型

Field	Type	Required	Description
`id`	Long	True	Model ID
`extendParam`	String	True	ttsConfig的Json串，记录tts参数信息（参照下面Description）
`materialName`	String	True	素材Name
`thumbnailUrl`	String	True	Thumbnail URL
`desc`	String	False	Notes
`createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
`updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

Field	Type	Required	Description
`vendorId`	Integer	True	vendorId
`voiceId`	String	True	Voice ID
`voiceName`	String	True	音色Name
`language`	String	True	Language
`speedRatio`	Integer	True	Speech rate
`pitchOffset`	Integer	True	Pitch
`volume`	Integer	True	Volume

# Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 10,
      "pageSize": 10,
      "startIndex": 0
    },
    "result": [
      {
        "id": 2221738,
        "extendParam": {
          "voiceId": "ttsId1",
          "speedRatio": 4,
          "pitchOffset": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型1",
        "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
        "desc": null,
        "createTime": "2023-01-13 12:31:13",
        "updateTime": "2023-01-13 12:31:13"
      },
      {
        "id": 1112226,
        "extendParam": {
          "voiceId": "ttsId2",
          "speedRatio": 4,
          "pitchOffset": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型2",
        "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
        "desc": null,
        "createTime": "2022-09-06 19:10:09",
        "updateTime": "2022-10-28 16:59:18"
      }
    ]
  }
}

# Get Specified Public TTS Personal Voice Models (Legacy)

# 接口Description

Returns specified public TTS personal voice models based on input parameters.

# Request URL

POST /api/2dvh/v1/material/tts

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`ids`	Long[]	True	Model ID array

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Array	False	Usually empty on error
- `id`	Long	True	Model ID
- `extendParam`	String	True	ttsConfig的Json串，记录tts参数信息（参照下面Description）
- `materialName`	String	True	素材Name
- `thumbnailUrl`	String	True	Thumbnail URL
- `desc`	String	False	Notes
- `createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
- `updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

Field	Type	Required	Description
`vendorId`	Integer	True	vendorId
`voiceId`	String	True	Voice ID
`voiceName`	String	True	音色Name
`language`	String	True	Language
`speedRatio`	Integer	True	Speech rate
`pitchOffset`	Integer	True	Pitch
`volume`	Integer	True	Volume

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 13,
      "extendParam": {
        "voiceId": "ttsId1",
        "speedRatio": 4,
        "pitchOffset": 1,
        "volume": 100
      },
      "materialName": "公共角色TTS音色模型1",
      "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
      "desc": null,
      "createTime": "2023-01-13 12:31:13",
      "updateTime": "2023-01-13 12:31:13"
    },
    {
      "id": 16,
      "extendParam": {
        "voiceId": "ttsId2",
        "speedRatio": 4,
        "pitchOffset": 1,
        "volume": 100
      },
      "materialName": "公共TTS个人音色模型2",
      "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
      "desc": null,
      "createTime": "2022-09-06 19:10:09",
      "updateTime": "2022-10-28 16:59:18"
    }
  ]
}

# Get All Public Video Templates

# 接口Description

Returns a paginated list of all public video templates.

Video templates record all information in the final synthesized video apart from the character and voice — including the background, foreground content displayed in front of the character, and text position, font, font size, etc.

# Request URL

POST /api/2dvh/v1/material/video/template/list

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`pageNo`	Integer	False	Current page number (default 1)
`pageSize`	Integer	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "pageNo": 1,
  "pageSize": 10
}

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	data object ，Usually empty on error
- `pagination`	Pagination	True	分页信息(参照共通Description)
- `result`	Array	False	Public video templates (refer to description below)

公共视频模板

Field	Type	Required	Description
`id`	Long	True	Template ID
`materialName`	String	True	Template name
`thumbnailUrl`	String	True	Thumbnail URL
`pkgUrl`	String	True	Template URL
`extendUrl`	String	True	Example video URL
`desc`	String	False	Notes
`createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
`updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

# Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "pagination": {
                "pageNo": 1,
                "numberPages": 1,
                "numberRecords": 10,
                "pageSize": 10,
                "startIndex": 0
            },
        "result": [{
            "id": 2221738,
            "materialName": "公共视频模板1",
            "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
            "pkgUrl": "https://oss/folderPath/demo_20230608150104747.json",
            "desc": null,
            "createTime": "2023-01-13 12:31:13",
            "updateTime": "2023-01-13 12:31:13"
        }, {
            "id": 1112226,
            "materialName": "公共视频模板2",
            "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
            "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
            "desc": null,
            "createTime": "2022-09-06 19:10:09",
            "updateTime": "2022-10-28 16:59:18"
        }]
    }
}

# Get Specified Public Video Templates

# 接口Description

Returns specified public video templates based on input parameters.

# Request URL

POST /api/2dvh/v1/material/video/template

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`ids`	Long[]	True	Video template ID array

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Array	False	Usually empty on error
- `id`	Long	True	Template ID
- `materialName`	String	True	Template name
- `thumbnailUrl`	String	True	Thumbnail URL
- `pkgUrl`	String	True	Template URL
- `extendUrl`	String	True	Example video URL
- `desc`	String	False	Notes
- `createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
- `updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "公共视频模板1",
    "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
    "pkgUrl": "https://oss/folderPath/test_2023011312230521517.json",
    "desc": null,
    "createTime": "2023-01-13 12:31:13",
    "updateTime": "2023-01-13 12:31:13"
  }, {
    "id": 16,
    "materialName": "公共视频模板2",
    "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
    "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
    "desc": null,
    "createTime": "2022-09-06 19:10:09",
    "updateTime": "2022-10-28 16:59:18"
  }]
}

# Get All Public Live Streaming Scripts

# 接口Description

Returns a paginated list of all public live streaming scripts.

# Request URL

POST /api/2dvh/v1/material/live/script/list

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`pageNo`	Integer	False	Current page number (default 1)
`pageSize`	Integer	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "pageNo": 1,
  "pageSize": 10
}

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	data object ，Usually empty on error
- `pagination`	Pagination	True	分页信息(参照共通Description)
- `result`	Array	False	Public live streaming scripts (refer to description below)

公共视频模板

Field	Type	Required	Description
`id`	Long	True	Template ID
`materialName`	String	True	Script name
`thumbnailUrl`	String	True	Thumbnail URL
`pkgUrl`	String	True	Script material URL
`extendUrl`	String	True	No content yet
`desc`	String	False	Notes
`createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
`updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

# Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "pagination": {
                "pageNo": 1,
                "numberPages": 1,
                "numberRecords": 10,
                "pageSize": 10,
                "startIndex": 0
            },
        "result": [{
            "id": 2221738,
            "materialName": "公共直播脚本1",
            "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
            "pkgUrl": "https://oss/folderPath/test_2023011312230521517.json",
            "desc": null,
            "createTime": "2023-01-13 12:31:13",
            "updateTime": "2023-01-13 12:31:13"
        }, {
            "id": 1112226,
            "materialName": "公共直播脚本2",
            "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
            "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
            "desc": null,
            "createTime": "2022-09-06 19:10:09",
            "updateTime": "2022-10-28 16:59:18"
        }]
    }
}

# Get Specified Public Live Streaming Scripts

# 接口Description

Returns specified public live streaming scripts based on input parameters.

# Request URL

POST /api/2dvh/v1/material/live/script

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`ids`	Long[]	True	Live streaming script ID array

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Array	False	Usually empty on error
- `id`	Long	True	Script ID
- `materialName`	String	True	直播Script name
- `thumbnailUrl`	String	True	Thumbnail URL
- `pkgUrl`	String	True	Script material package URL
- `extendUrl`	String	True	N/A
- `desc`	String	False	Notes
- `createTime`	String	True	Creation time，yyyy-MM-dd HH:mm:ss
- `updateTime`	String	True	Last update time，yyyy-MM-dd HH:mm:ss

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "公共直播脚本1",
    "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
    "pkgUrl": "https://oss/folderPath/test_2023011312230521517.json",
    "desc": null,
    "createTime": "2023-01-13 12:31:13",
    "updateTime": "2023-01-13 12:31:13"
  }, {
    "id": 16,
    "materialName": "公共直播脚本2",
    "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
    "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
    "desc": null,
    "createTime": "2022-09-06 19:10:09",
    "updateTime": "2022-10-28 16:59:18"
  }]
}

# Get Specified Task Information

# 接口Description

Queries the corresponding task information and current task status based on the task ID provided by the user.

# Request URL

POST /api/2dvh/v1/task/info

# Request Headers

Content-Type: application/json

# Request Parameters

JSON数组格式，数组中对象的Field定义如下：

Field	Type	Required	Description
`ids`	Long[]	True	Task ID list

# Request Example

{
    "ids": [7,27]
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task information
- `id`	Long	True	Task ID
- `materialId`	Integer	True	Material ID
- `materialName`	String	True	素材Name
- `algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,20:视频人物换脸,18:人物形象模型更新，25:音色转换， 32:图片绿幕分割预览，33:视频绿幕分割预览，37:视频直播，41:TTS V3音色模型生成，42:口水话(快速答复库)，43:文件预热, 44:接管视频生成, 45:文件预热删除 )
- `algoSubType1`	String	True	人物模型：模型规格：2K/4K，视频合成：使用人物模型规格：2K/4K
- `algoSubType2`	String	False	视频合成：结果物格式：webm/mp4
- `algoSubType3`	String	False	视频合成：结果物帧率
- `status`	Integer	True	任务状态,0:未开始，1:Dispatcher队列等待中，2:算法正在处理，3:已取消，5:已完成，9:异常
- `extendParam`	String	False	Extended parameters
- `productParam`	String	True	Task result JSON string, format varies by task type.
- `startTime`	String	True	Algorithm start time（yyyy-MM-dd HH:mm:ss）
- `endTime`	String	True	Algorithm end time（yyyy-MM-dd HH:mm:ss）

# case1：视频合成

Field	Type	Required	Description
`duration`	Integer	True	Synthesized video duration (unit: milliseconds)
`lastFrameIndex`	Integer	True	Video ending frame
`algoSubType1`	String	True	视频合成：使用人物模型规格：2K/4K
`algoSubType2`	String	True	视频合成：结果物格式：webm/mp4
`algoSubType3`	String	True	视频合成：结果物帧率
`thumbPath`	String	True	Thumbnail download URL (valid for 7 days)
`videoPath`	String	True	Video download URL (valid for 7 days)

# case1 返回样例：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "id": 913318,
            "materialId": 854513,
            "materialName": "913288",
            "productParam": "{\"duration\": 880, \"thumbPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxxx/thumb.png\", \"videoPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxxx/video.mp4\"}",
            "extendParam": null,
            "startTime": "2024-05-27 16:38:54",
            "endTime": "2024-05-27 16:39:03",
            "status": 5,
            "message": "{\"time_info\": {\"parse_json\": {\"avg\": 15, \"end\": \"2024-05-27 16:38:52.913\", \"sum\": 15, \"start\": \"2024-05-27 16:38:52.897\"}, \"preprocess\": {\"avg\": 342, \"end\": \"2024-05-27 16:38:56.134\", \"sum\": 342, \"start\": \"2024-05-27 16:38:55.792\"}, \"postprocess\": {\"avg\": 380, \"end\": \"2024-05-27 16:39:02.351\", \"sum\": 380, \"start\": \"2024-05-27 16:39:01.971\"}, \"main_process\": {\"avg\": 5837, \"end\": \"2024-05-27 16:39:01.971\", \"sum\": 5837, \"start\": \"2024-05-27 16:38:56.134\"}, \"audio_process\": {\"avg\": 123.91666412353516, \"sum\": 2974}, \"video_process\": {\"avg\": 9.47826099395752, \"sum\": 218}, \"wait_srt_stream\": {\"avg\": 0, \"sum\": 0}, \"send_task_response\": {\"start\": \"2024-05-27 16:39:02.775\"}, \"receive_task_from_agent\": {\"start\": \"2024-05-27 16:38:52.897\"}, \"st_mobile_change_package\": {\"avg\": 1832, \"end\": \"2024-05-27 16:38:54.745\", \"sum\": 1832, \"start\": \"2024-05-27 16:38:52.913\"}}, \"video_info\": {\"fps\": 25, \"format\": \"mp4\", \"digital_type\": \"2K\", \"last_frame_index\": 22}}",
            "algoType": 14,
            "algoId": "8216eaea6xxxxxx2e0798d21",
            "algoSubType1": "2K",
            "algoSubType2": "mp4",
            "algoSubType3": "25",
            "isDelete": 0
        }
    ]
}

# case2：人物形象模型生成

Field	Type	Required	Description
`thumbPath`	String	True	基础视频生成人物模型Thumbnail download URL (valid for 7 days)
`multi`	Array	True	Model results
- `width`	String	True	Width
- `width`	String	True	Height
- `pkgPath`	String	True	Avatar download URL (valid for 7 days),多视频人物模型生成时无此Field返回
- `thumbPath`	String	True	视频生成人物模型Thumbnail download URL (valid for 7 days)
- `faceFeatureId`	String	True	ff id
- `userJson`	String	True	Training parameters
- `avatarResultJson`	String	True	Training results

# case2 返回样例：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "id": 908438,
            "materialId": 850297,
            "materialName": "蘇xxx",
            "productParam": "{\"multi\": [{\"common\": {\"pkgPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.x.com/x/116/xxxx/input_source/2/xx.zip\", \"userJson\": \"https://dwg-aigc-paas.oss-cnxxxx/input_source/2/xxx.json\", \"thumbPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxx/input_source/2/xxx.png\", \"faceFeatureId\": \"xxxxx\"}, \"origin\": {\"pkgPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/2bd5e869e94d4995967428fa7ad7cf49_s1/input_source/0/xxx.zip\", \"userJson\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxx/input_source/0/xxx.json\", \"thumbPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxx/input_source/0/xxx.png\", \"faceFeatureId\": \"2bd5e869e94dxxxxxa7ad7cf49_s1_0\"}, \"videoUrl\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/xxxxB.mp4\"}], \"thumbPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxx/input_source/0/xxx.png\"}",
            "extendParam": null,
            "startTime": "2024-05-22 18:14:21",
            "endTime": "2024-05-22 21:57:19",
            "status": 5,
            "message": "{}",
            "algoType": 12,
            "algoId": "2bd5exxxxxa7ad7cf49_s1",
            "algoSubType1": "4K",
            "algoSubType2": "multi",
            "algoSubType3": "normal",
            "isDelete": 0
        }
    ]
}

# case3：（多视频）人物形象模型生成(/model/multi/create接口结果)

Field	Type	Required	Description
`thumbPath`	String	True	基础视频生成人物模型Thumbnail download URL (valid for 7 days)
`multi`	Array	False	Multi-video avatar model generation results, content is an array
- `videoUrl`	String	True	Original video file URL
- `orgin`	Object	True	Original lip-sync avatar model object （stage1Template参数为0）
- - `thumbPath`	String	True	人物模型Thumbnail download URL (valid for 7 days)
- - `pkgPath`	String	True	Avatar model download URL (valid for 7 days)
- - `faceFeatureId`	String	True	Face Feature Id
- - `userJson`	String	True	User Json 信息
- - `avatarResultJson`	String	True	Avatar Result Json 信息
- `common`	Object	True	Universal lip-sync avatar model object （stage1Template参数为1 ）
- - `thumbPath`	String	True	人物模型Thumbnail download URL (valid for 7 days)
- - `pkgPath`	String	True	Avatar model download URL (valid for 7 days)
- - `faceFeatureId`	String	True	Face Feature Id
- - `userJson`	String	True	User Json 信息
- - `avatarResultJson`	String	True	Avatar Result Json 信息

# case3 productParam 返回样例：

{
    "multi": [{
        "common": {
            "pkgPath": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/xxx47_s1_input_source_2_result.zip",
            "userJson": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/ss_user.json",
            "thumbPath": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/xxlt.png",
            "faceFeatureId": "8c19c600a75addd9e666eca06413f47_s1_1",
                         "avatarResultJson": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/xxlt.Json"
        },
        "origin": {
            "pkgPath": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/aa_0_result.zip",
            "userJson": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/bbuser.json",
            "thumbPath": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/xx0_result.png",
            "faceFeatureId": "8c19c600a75a4f323e666eca06413f47_s1_0",
                         "avatarResultJson": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/xxlt.Json"
        },
        "videoUrl": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/xx.mp4"
    }],
    "thumbPath": "https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/xx.png"
}

# case4：人物形象模型更新

Field	Type	Required	Description
`thumbPath`	String	True	人物模型Thumbnail download URL (valid for 7 days)
`pkgPath`	String	True	Avatar model download URL (valid for 7 days)
`modelInfo`	String	True	人物模型：模型规格：2K/4K

# case4 返回样例：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "id": 890212,
            "materialId": 833961,
            "materialName": "KURUMI",
            "productParam": "{\"pkgPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxxx/xxx.zip\", \"userJson\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxxx/xxxx.json\", \"modelInfo\": \"2K\", \"thumbPath\": \"https://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/download/116/xxx/xxxx.png\"}",
            "extendParam": null,
            "startTime": "2024-05-10 10:51:35",
            "endTime": "2024-05-10 11:50:24",
            "status": 5,
            "message": "{}",
            "algoType": 18,
            "algoId": "cut_bf9c19046exxxxxb9af791587_s1",
            "algoSubType1": "2K",
            "algoSubType2": null,
            "algoSubType3": "normal",
            "isDelete": 0
        }
    ]
}

# case5： TTS音色模型生成（旧）（不建议使用）

Field	Type	Required	Description
`taskId`	String	True	Corresponding task ID
`voice`	Object	True	Voice information
- `id`	String	True	Voice ID
- `name`	String	True	发音人Name
- `gender`	Integer	True	发音人性别。0 = Not known。1 = Male。2 = Female。9 = Not applicable
- `language`	String	True	发音人Language。zh-CN中文普通话，en-US美式英文
- `vendor_id`	Integer	True	Voice vendor ID
`taskStatus`	Integer	True	任务状态。1 = 排队中。2 = 任务进行中。3 = 已取消。5 = 已完成。 9 = 异常。
`msg`	String	True	Task status description.
`stage`	String	True	任务子步骤。preprocess：数据预处理。label：数据标注。training：模型训练。deployment：部署阶段。
`stageStatus`	Integer	True	阶段状态。1 = 排队中。2 = 任务进行中。5 = 已完成。 9 = 异常。
`sampleAudioUrl`	String	False	Sample audio URL (valid for 7 days)
`tenant`	String	True	Tenant owning the task
`updatedTime`	String	True	Task information update time in RFC3339 format.
`modelUrl`	String	False	任务成功时返回模型下载地址，仅内网可用。暂不对外提供

# case6：视频人物换脸

Field	Type	Required	Description
`thumbPath`	String	True	缩略图下载地址（7天有效）
`pkgPath`	String	True	Avatar download URL (valid for 7 days)

# case7： TTS -Qid音色模型生成

Field	Type	Required	Description
`taskId`	String	True	Corresponding task ID
`voice`	Object	True	Voice information
- `qid`	String	True	Voice QID
- `name`	String	True	发音人Name
- `gender`	Integer	True	发音人性别。0 = Not known。1 = Male。2 = Female。9 = Not applicable
- `languages`	String	True	发音人支持的Language列表。zh-CN中文普通话，en-US美式英文，仅当任务完成时返回
`taskType`	String	True	Voice training algorithm type
`taskStatus`	Integer	True	任务状态。1 = 排队中。2 = 任务进行中。3 = 已取消。5 = 已完成。 9 = 异常。
`msg`	String	True	Task status description.
`stage`	String	True	任务子步骤。preprocess：数据预处理。label：数据标注。training：模型训练。deployment：部署阶段。
`stageStatus`	Integer	True	阶段状态。1 = 排队中。2 = 任务进行中。5 = 已完成。 9 = 异常。
`sampleAudioUrl`	String	False	Sample audio URL (valid for 7 days)
`tenant`	String	True	Tenant owning the task
`updatedTime`	String	True	Task information update time in RFC3339 format.

extendParam中人物形象模型参数信息

Field	Type	Required	Description
`faceFeatureId`	String	True	Face Feature Id

# case7 返回样例：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "id": 206216,
            "materialId": 1990411,
            "materialName": "TTS_yunynsent",
            "productParam": "{\"msg\":\"task is finished\",\"stage\":\"deployment\",\"voice\":{\"qid\":\"VQ1fQv:AEAygt1ixxxxxxdRPNLE11kg1TLXWSzMxNExLTksK\",\"name\":\"TTS6_yunyxxxxxen_consent\",\"gender\":1,\"languages\":[\"en-US\",\"zh-CN\",\"af-ZA\",\"am-ET\",\"ar-EG\",\"ar-SA\",\"az-AZ\",\"bg-BG\",\"bn-BD\",\"bn-IN\",\"bs-BA\",\"ca-ES\",\"cs-CZ\",\"cy-GB\",\"da-DK\",\"de-AT\",\"de-CH\",\"de-DE\",\"el-GR\",\"en-AU\",\"en-CA\",\"en-GB\",\"en-IE\",\"en-IN\",\"es-ES\",\"es-MX\",\"et-EE\",\"eu-ES\",\"fa-IR\",\"fi-FI\",\"fil-PH\",\"fr-BE\",\"fr-CA\",\"fr-CH\",\"fr-FR\",\"ga-IE\",\"gl-ES\",\"he-IL\",\"hi-IN\",\"hr-HR\",\"hu-HU\",\"hy-AM\",\"id-ID\",\"is-IS\",\"it-IT\",\"ja-JP\",\"jv-ID\",\"ka-GE\",\"kk-KZ\",\"km-KH\",\"kn-IN\",\"ko-KR\",\"lo-LA\",\"lt-LT\",\"lv-LV\",\"mk-MK\",\"ml-IN\",\"mn-MN\",\"ms-MY\",\"mt-MT\",\"my-MM\",\"nb-NO\",\"ne-NP\",\"nl-BE\",\"nl-NL\",\"pl-PL\",\"ps-AF\",\"pt-BR\",\"pt-PT\",\"ro-RO\",\"ru-RU\",\"si-LK\",\"sk-SK\",\"sl-SI\",\"so-SO\",\"sq-AL\",\"sr-RS\",\"su-ID\",\"sv-SE\",\"sw-KE\",\"ta-IN\",\"te-IN\",\"th-TH\",\"tr-TR\",\"uk-UA\",\"ur-PK\",\"uz-UZ\",\"vi-VN\",\"zh-HK\",\"zh-TW\",\"zu-ZA\"]},\"taskId\":\"tts6-xxx-xxxx-xxx-xx-789308\",\"tenant\":\"0\",\"taskType\":\"TTS6\",\"taskStatus\":5,\"stageStatus\":5,\"updatedTime\":\"2024-05-29T09:41:51.373802578Z\",\"sampleAudioUrl\":\"\"}",
            "extendParam": null,
            "startTime": "2024-05-29 17:38:31",
            "endTime": "2024-05-29 17:41:51",
            "status": 5,
            "message": "{\"tts resp msg\": \"task is finished\"}",
            "algoType": 41,
            "algoId": "f627-a980-78aba9c20308",
            "algoSubType1": null,
            "algoSubType2": null,
            "algoSubType3": null,
            "isDelete": 0
        }
    ]
}

# case8：文件预热(失败信息，预热成功文件不展示)

Field	Type	Required	Description
`fileWarmingDetails`	Array	False	Failed file information
- `fileId`	String	True	File ID
- `warmingResult`	String	True	File preheating failure reason

# case8 返回样例：

{
    "code": 0,
    "message": "success",
    "data": {
      "fileWarmingDetails": [
        {
          "fileId": "f627-a980-78aba9c20308",
          "warmingResult": "download error"
        },
        {
          "fileId": "xde37-a980-78aba9c20308",
          "warmingResult": "download error"
        }
      ]
    }
}

# case9：视频转码(已转码返回下载地址fileTranscodeUrl,错误返回Error messagemsg)

Field	Type	Required	Description
`fileTranscodeDetails`	Array	False	Failed file information
- `fileUrl`	String	True	File URL
- `transcodeResult`	Boolean	True	Whether transcoded
- `fileTranscodeUrl`	String	False	File transcoding download URL
- `msg`	String	False	Description

# case9 返回样例：

{
    "code": 0,
    "message": "success",
    "data": {
      "fileWarmingDetails": [
        {
          "msg": "转码成功",
          "fileUrl": "https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/r/output_fps_20.mp4",
          "transcodeResult": true,
          "fileTranscodeUrl": "https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com//transcode/136/03-4593-bdf6-89d4ceb858d0/1c34c46c58e0d7f3b5de5a91d_25fps.mp4"
        }, {
          "msg": "FPS在[22,28]范围内，无需转码，FPS: 25.0",
          "fileUrl": "https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/qo/1680701351547_%25E6%25B5%25B7%25E6%25B4%258B.mp4",
          "transcodeResult": false
        }
      ]
    }
}

# Get Account Task Information

# 接口Description

Queries all task information and current task status under a specific algorithm type for the user account. The task list supports pagination.

# Request URL

POST /api/2dvh/v1/task/listByAccount

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,20:视频人物换脸,18:人物形象模型更新，25:音色转换， 32:图片绿幕分割预览，33:视频绿幕分割预览，37:视频直播，41:TTS V3音色模型生成，42:口水话(快速答复库)，43:文件预热, 44:接管视频生成, 45:文件预热删除）
`pageNo`	int	False	Current page number (default 1)
`pageSize`	int	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "algoType": 12,
  "pageSize": 10,
  "pageNo": 1
}

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	data object ，Usually empty on error
- `pagination`	Pagination	True	分页信息(参照通用数据结构Description)
- `result`	Object	True	Task list (refer to description below)

任务列表

Field	Type	Required	Description
`id`	Long	True	Task ID
`algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,20: 视频人物换脸,18:人物形象模型更新，25:音色转换， 32:图片绿幕分割预览，33:视频绿幕分割预览，37:视频直播，41:TTS V3音色模型生成，42:口水话(快速答复库)，43:文件预热, 44:接管视频生成, 45:文件预热删除）
`algoSubType1`	String	True	人物模型：模型规格：2K/4K，视频合成：使用人物模型规格：2K/4K
`algoSubType2`	String	False	视频合成：结果物格式：webm/mp4
`algoSubType3`	String	False	视频合成：结果物帧率
`status`	Integer	True	任务状态 0:未开始，1:Dispatcher队列等待中，2:算法正在处理，3:已取消，5:已完成，9:异常
`productParam`	String	True	任务结果json串，包含视频地址videoPath，视频时长duration，截图地址thumbPath
`startTime`	String	True	Algorithm start time（yyyy-MM-dd HH:mm:ss）
`endTime`	String	True	Algorithm end time（yyyy-MM-dd HH:mm:ss）

# Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 2,
      "pageSize": 2,
      "startIndex": 0
    },
    "result": [
      {
        "id": 27,
        "algoType": 12,
        "algoSubType1": "4K",
        "algoSubType2": null,
        "algoSubType3": null,
        "productParam": "\"{\\\"duration\\\":1234,\\\"thumbPath\\\":\\\"https://oss-cn-hangzhou.aliyuncs.com/dwg-aigc-paas/materials/a8610d001aaa412ab2e0433fc848b48f/thumb.jpg\\\",\\\"videoPath\\\":\\\"https://oss-cn-hangzhou.aliyuncs.com/dwg-aigc-paas/materials/a8610d001aaa412ab2e0433fc848b48f/output.mp4\\\"}\"",
        "startTime": "2023-02-17 16:53:26",
        "endTime": "2023-02-18 10:03:21",
        "status": 5
      },
      {
        "id": 7,
        "algoType": 12,
        "algoSubType1": "4K",
        "algoSubType2": null,
        "algoSubType3": null,
        "productParam": "{}",
        "startTime": "2023-02-17 16:56:26",
        "endTime": "2023-02-17 17:43:19",
        "status": 9
      }
    ]
  }
}

# Get Account Task Information Details

# 接口Description

Queries all task information under a specific algorithm type for the account, including current task status, original input content, returned results, and other details. The task list supports pagination.

# Request URL

POST /api/2dvh/v1/task/listWithQueue

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`userId`	Long	False	User ID, defaults to current logged-in account ID
`algoType`	Integer	True	任务Type（11:TTS音色模型生成（旧）,12:人物形象模型生成,14:视频合成,20: 视频人物换脸,18:人物形象模型更新，25:音色转换， 32:图片绿幕分割预览，33:视频绿幕分割预览，37:视频直播，41:TTS Qid音色模型生成）
`status`	Integer	True	任务状态 (0:未开始，1:Dispatcher队列等待中，2:算法正在处理，3:已取消，5:已完成，9:异常, -1: 全部 )
`key`	String	False	Task ID / role name query (exact match)
`pageNo`	int	False	Current page number (default 1)
`pageSize`	int	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "algoType": 12,
  "pageSize": 10,
  "pageNo": 1
}

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	data object ，Usually empty on error
- `pagination`	Pagination	True	分页信息(参照通用数据结构Description)
- `result`	Object	True	Task list (refer to description below)

任务列表

Field	Type	Required	Description
`id`	Long	True	Task ID
`algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,20: 视频人物换脸,18:人物形象模型更新，25:音色转换， 32:图片绿幕分割预览，33:视频绿幕分割预览，37:视频直播，41:TTS V3音色模型生成，42:口水话(快速答复库)，43:文件预热, 44:接管视频生成, 45:文件预热删除
`materialId`	Long	True	Model ID
`materialName`	String	True	素材Name
`queueInfo`	String	False	Queue information
`status`	Integer	True	任务状态 0:未开始,1:Dispatcher队列等待中,2:算法正在处理,3:已取消,5:已完成,9:异常
`productParam`	String	True	任务结果json串，包含视频地址videoPath，视频时长duration，截图地址thumbPath
`extendParam`	String	False	Extended parameters，人物形象模型生成时包含faceFeatureId
`algoSubType1`	String	True	人物模型：模型规格：2K/4K，视频合成：使用人物模型规格：2K/4K
`algoSubType2`	String	False	视频合成：结果物格式：webm/mp4
`algoSubType3`	String	False	视频合成：结果物帧率
`taskInfo`	String	True	Task initial parameters and original files
`algoId`	String	True	Algorithm task ID
`message`	String	False	Error message
`submitTime`	String	True	Algorithm submission time（yyyy-MM-dd HH:mm:ss）
`startTime`	String	False	Algorithm start time（yyyy-MM-dd HH:mm:ss）
`endTime`	String	False	Algorithm end time（yyyy-MM-dd HH:mm:ss）
`owner`	Long	True	Account owning the task
`ownerPhone`	String	True	Account phone number

# Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 2,
      "pageSize": 2,
      "startIndex": 0
    },
    "result": [
      {
        "id": 8833,
        "materialId": 8122,
        "materialName": "Mario_4_talk.mp4_sensetime-segment_type_绿幕分割",
        "productParam": "{\"pkgPath\": \"https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/download/8/b6ecebc8233b47809dedd6731c052d15_s1/b6ecebc8233b47809dedd6731c052d15_s1_result.zip\", \"thumbPath\": \"https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/download/8/b6ecebc8233b47809dedd6731c052d15_s1/b6ecebc8233b47809dedd6731c052d15_s1_result.png\", \"faceFeaturePath\": \"https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/download/8/b6ecebc8233b47809dedd6731c052d15_s1/b6ecebc8233b47809dedd6731c052d15_s1_face_feature.zip\"}",
        "extendParam": "{\"faceFeatureId\": \"b6ecebc8233b47809dedd6731c052d15_s1\"}",
        "startTime": "2023-06-07 23:31:50",
        "endTime": "2023-06-08 05:19:29",
        "status": 5,
        "message": "{}",
        "algoType": 12,
        "algoId": "b6ecebc8233b47809dedd6731c052d15_s1",
        "algoSubType1": "4K",
        "algoSubType2": null,
        "algoSubType3": null,
        "submitTime": "2023-06-07 17:34:40",
        "ownerPhone": "18311096857",
        "owner": 8,
        "queueInfo": null,
        "taskInfo": "{\"create2DAvatarModel\": {\"videoUrl\": \"https://ailab-storage-eus.oss-us-west-1.aliyuncs.com/31_trim_result/Mario_4_talk.mp4?OSSAccessKeyId=LTAI5tE2Hq2BAqr8EBzxmSrR&Expires=37686060051&Signature=C1L%2FxpHD%2FW155s%2BuhTocyVvsUfo%3D\", \"accountId\": 8, \"assetScale\": 1.0, \"existTaskId\": 0, \"firstCreate\": true, \"materialName\": \"Mario_4_talk.mp4_sensetime-segment_type_绿幕分割\", \"segmentStyle\": 1}}"
      },
      {
        "id": 9093,
        "materialId": 8258,
        "materialName": "wu0609_sensetime-segment_type_绿幕分割",
        "productParam": null,
        "extendParam": null,
        "startTime": "2023-06-09 10:56:38",
        "endTime": null,
        "status": 2,
        "message": "{}",
        "algoType": 12,
        "algoId": "5f6006acb891496f93bfeeff601201fe_s1",
        "algoSubType1": "4K",
        "algoSubType2": null,
        "algoSubType3": null,
        "submitTime": "2023-06-09 10:56:36",
        "ownerPhone": "18311096857",
        "owner": 8,
        "queueInfo": null,
        "taskInfo": "{\"create2DAvatarModel\": {\"videoUrl\": \"http://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/wanxing_0606/zhuzong.mp4\", \"accountId\": 8, \"assetScale\": 1.0, \"existTaskId\": 0, \"firstCreate\": true, \"materialName\": \"wu0609_sensetime-segment_type_绿幕分割\", \"segmentStyle\": 1}}"
      },
      {
        "id": 8528,
        "materialId": 7908,
        "materialName": "Claire_3_talk.mp4_sensetime-segment_type_绿幕分割",
        "productParam": "{\"pkgPath\": \"https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/download/8/1907b913f78845168529bad59f36a43f_s1/1907b913f78845168529bad59f36a43f_s1_result.zip\", \"thumbPath\": \"https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/download/8/1907b913f78845168529bad59f36a43f_s1/1907b913f78845168529bad59f36a43f_s1_result.png\", \"faceFeaturePath\": \"https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/download/8/1907b913f78845168529bad59f36a43f_s1/1907b913f78845168529bad59f36a43f_s1_face_feature.zip\"}",
        "extendParam": "{\"faceFeatureId\": \"1907b913f78845168529bad59f36a43f_s1\"}",
        "startTime": "2023-06-06 02:32:13",
        "endTime": "2023-06-06 20:17:19",
        "status": 9,
        "message": "{\"errorMsg\": \"Algorithm heart beat is overtime!!!\"}",
        "algoType": 12,
        "algoId": "1907b913f78845168529bad59f36a43f_s1",
        "algoSubType1": "4K",
        "algoSubType2": null,
        "algoSubType3": null,
        "submitTime": "2023-06-05 20:41:43",
        "ownerPhone": "18311096857",
        "owner": 8,
        "queueInfo": null,
        "taskInfo": "{\"create2DAvatarModel\": {\"videoUrl\": \"https://ailab-storage-eus.oss-us-west-1.aliyuncs.com/online_videos/Claire_3_talk.mp4?OSSAccessKeyId=LTAI5tE2Hq2BAqr8EBzxmSrR&Expires=1689391554&Signature=pMSBmAlawZ7h2sxjUO8Dk%2B1dHRg%3D\", \"accountId\": 8, \"assetScale\": 1.0, \"existTaskId\": 0, \"firstCreate\": true, \"materialName\": \"Claire_3_talk.mp4_sensetime-segment_type_绿幕分割\", \"segmentStyle\": 2}}"
      },
      {
        "id": 9161,
        "materialId": 8317,
        "materialName": "Eddie_3_talk_trim_sensetime_0_绿幕分割",
        "productParam": null,
        "extendParam": null,
        "startTime": null,
        "endTime": null,
        "status": 1,
        "message": "{}",
        "algoType": 18,
        "algoId": "1667070933254279169",
        "algoSubType1": "4K",
        "algoSubType2": null,
        "algoSubType3": null,
        "submitTime": "2023-06-09 15:28:48",
        "ownerPhone": "18311096857",
        "owner": 8,
        "queueInfo": "8/9",
        "taskInfo": "{\"rebuild2DAvatarModelVideo\": {\"assetEnd\": 120.0, \"modelUrl\": \"https://dwg-aigc-paas-test.oss-cn-hangzhou.aliyuncs.com/download/8/ba80636d8a77423083af66174375a130_s1/ba80636d8a77423083af66174375a130_s1_result.zip\", \"videoUrl\": \"http://dwg-aigc-paas.oss-cn-hangzhou.aliyuncs.com/wanxing_0606/Eddie_3_talk_trim.mp4.mp4\", \"accountId\": 8, \"assetScale\": 1.0, \"assetStart\": 60.0, \"existTaskId\": 0, \"firstCreate\": true, \"materialName\": \"Eddie_3_talk_trim_sensetime_0_绿幕分割\", \"segmentStyle\": 1}}"
      }
    ]
  }
}

# Cancel Task

# 接口Description

Allows users to cancel tasks that are in progress. After successful cancellation, the task status will be set to cancelled.

# Request URL

GET /api/2dvh/v1/task/cancel

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`id`	Long	True	Task ID

# Request Example

http://xxx/api/2dvh/v1/task/cancel?id=1

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Value is empty

# Response Example

{
    "code": 0,
    "message": "success",
    "data": null
}

# Delete Task

# 接口Description

Allows users to delete tasks that are not in progress. After deletion, task information will no longer be retained.

# Request URL

DELETE /api/2dvh/v1/task/del

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`id`	Long	True	Task ID

# Request Example

http://xxx/api/2dvh/v1/task/del/id

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Value is empty

# Response Example

{
    "code": 0,
    "message": "success",
    "data": null
}

# Restart Task

# 接口Description

Allows users to restart failed tasks. The task ID remains unchanged after restart.

# Request URL

GET /api/2dvh/v1/task/restart

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`id`	Long	True	task id

# Request Example

http://xxx/api/2dvh/v1/task/restart?id=1

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	False	Task ID

# Response Example

{
    "code": 0,
    "message": "success",
    "data": 2
}

# Query Task Phase Duration Information

# 接口Description

Queries the duration information for each phase of a task. Currently only supports video synthesis.

# Request URL

GET /api/2dvh/v1/task/phase/cost

# Request Headers

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`id`	Long	True	Task ID

# Request Example

https://xxx/api/2dvh/v1/task/phase/cost?id=1

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Array	False	Value is empty
- `phase`	String	True	算法阶段：asset_download:素材下载 parse_json:json解析时间 st_mobile_change_package:加载Digital human资源 preprocess:前处理时间，准备各类资源 main_process:音视频处理 postprocess:ffmpeg视频后处理 result_upload:结果上传
- `startTime`	String	True	Phase start time（yyyy-MM-dd HH:mm:ss）
- `endTime`	String	True	Phase completion time（yyyy-MM-dd HH:mm:ss）
- `costTime`	String	True	Duration (milliseconds)
- `callCount`	Integer	False	Phase repetition count; empty value means no repetition

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 291340,
      "phase": "asset_download",
      "startTime": "2023-11-01 16:41:17",
      "endTime": "2023-11-01 16:41:17",
      "costTime": 0
    },
    {
      "id": 291340,
      "phase": "parse_json",
      "startTime": "2023-11-01 16:41:17",
      "endTime": "2023-11-01 16:41:18",
      "costTime": 124
    },
    {
      "id": 291340,
      "phase": "st_mobile_change_package",
      "startTime": "2023-11-01 16:41:18",
      "endTime": "2023-11-01 16:41:20",
      "costTime": 2242
    },
    {
      "id": 291340,
      "phase": "preprocess",
      "startTime": "2023-11-01 16:41:20",
      "endTime": "2023-11-01 16:41:21",
      "costTime": 1238
    },
    {
      "id": 291340,
      "phase": "main_process",
      "startTime": "2023-11-01 16:41:21",
      "endTime": "2023-11-01 16:41:25",
      "costTime": 3692
    },
    {
      "id": 291340,
      "phase": "result_upload",
      "startTime": "2023-11-01 16:41:25",
      "endTime": "2023-11-01 16:41:25",
      "costTime": 189
    },
    {
      "id": 291340,
      "phase": "postprocess",
      "startTime": "2023-11-01 16:41:25",
      "endTime": "2023-11-01 16:41:25",
      "costTime": 457
    }
  ]
}

# Billing Query Service (Non-Voice)

# 接口Description

Billing query service. Maximum 1000 records per query. Queries exceeding 1000 records will not be processed; please narrow the query range and try again.

# Request URL

POST /api/assist/bill/list

# Request Parameters

Field	Type	Required	Description
`owner`	Long	True	Account owning the task
`algoGroup`	Integer	True	任务组（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,17:互动直播, 44:视频直播）
`algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,17:互动直播, 44:视频直播）
`billStartTime`	String	True	账单开始时间（格式为"YYYY-MM-DD HH:MM:SS"）
`billEndTime`	String	True	账单结束时间（格式为"YYYY-MM-DD HH:MM:SS"）
`pageNo`	int	False	Current page number (default 1)
`pageSize`	int	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "owner": 41 ,
  "algoType": "14",
  "algoGroup": "14",
  "billStartTime": "2024-12-04 00:00:00",
  "billEndTime": "2025-01-02 23:59:59",
  "pageSize": 10,
  "pageNo": 1,
  "sortName": "",
  "sortValue": ""
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	True	成功与否，成功是1 ，错误返回null
- `pagination`	Pagination	True	分页信息(参照通用数据结构Description)
- `result`	Object	True	Billing list (refer to description below)
- `usedSum`	String	True	Total usage on current page

账单列表

Field	Type	Required	Description
`id`	Long	True	Task ID
`owner`	Long	True	Account owning the task
`algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,17:互动直播, 44:视频直播）
`billingValue`	Integer	True	Billing value
`billingUnit`	Integer	True	计费单位（1:时长单位:毫秒,2：时长单位：秒,3：单位：数量)
`billingTime`	String	True	Billing time，格式为"YYYY-MM-DD HH:MM:SS"
`taskId`	Long	True	Task ID
`taskName`	String	True	Task name
`algoId`	String	True	Algorithm task ID
`status`	Integer	True	3:已取消,5:已完成,9:异常
`taskIsDelete`	String	True	Whether the task has been deleted (0: Not deleted, 1: Deleted)
`startTime`	String	True	Algorithm start time（yyyy-MM-dd HH:mm:ss）
`endTime`	String	True	Algorithm end time（yyyy-MM-dd HH:mm:ss）
`resultFile`	String	False	Result file path
`resultThumb`	String	False	Result thumbnail path
`algoSubType1`	String	True	人物模型：模型规格：2K/4K，视频合成：使用人物模型规格：2K/4K
`algoSubType2`	String	False	视频合成：结果物格式：webm/mp4
`algoSubType3`	String	False	视频合成：结果物帧率
`algoSubType4`	String	False	子Type4
`message`	String	False	Task information

# Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 3,
      "pageSize": 10,
      "startIndex": 0
    },
    "result": [
      {
        "id": 601057,
        "owner": 41,
        "billingValue": 30,
        "billingUnit": 2,
        "billingTime": "2024-12-27 15:03:09",
        "taskId": 20989677953,
        "taskName": null,
        "algoId": "db1fb10d0007485b8f7f41e6ebd41be7",
        "algoType": 17,
        "status": 5,
        "taskIsDelete": 0,
        "startTime": "2024-12-27 15:02:39",
        "endTime": "2024-12-27 15:03:09",
        "resultFile": null,
        "resultThumb": null,
        "message": "客户主动关闭",
        "algoSubType1": null,
        "algoSubType2": null,
        "algoSubType3": null,
        "algoSubType4": null
      },
      {
        "id": 601056,
        "owner": 41,
        "billingValue": 1,
        "billingUnit": 2,
        "billingTime": "2024-12-27 14:58:33",
        "taskId": 20989677950,
        "taskName": null,
        "algoId": "980f8051b5a9499592cd34530fd90cbf",
        "algoType": 17,
        "status": 5,
        "taskIsDelete": 0,
        "startTime": "2024-12-27 14:58:32",
        "endTime": "2024-12-27 14:58:33",
        "resultFile": null,
        "resultThumb": null,
        "message": "客户主动关闭",
        "algoSubType1": null,
        "algoSubType2": null,
        "algoSubType3": null,
        "algoSubType4": null
      },
      {
        "id": 601055,
        "owner": 41,
        "billingValue": 2,
        "billingUnit": 2,
        "billingTime": "2024-12-27 14:58:27",
        "taskId": 20989677949,
        "taskName": null,
        "algoId": "787c8923f67c447fbed38df345551789",
        "algoType": 17,
        "status": 5,
        "taskIsDelete": 0,
        "startTime": "2024-12-27 14:58:26",
        "endTime": "2024-12-27 14:58:28",
        "resultFile": null,
        "resultThumb": null,
        "message": "客户主动关闭",
        "algoSubType1": null,
        "algoSubType2": null,
        "algoSubType3": null,
        "algoSubType4": null
      }
    ],
    "usedSum": "0.55",
    "usedModel2kSum": null,
    "usedModel4kSum": null
  }
}

# Billing Query Service (Voice)

# 接口Description

Voice billing query service.

# Request URL

POST /api/assist/bill/voice/list

# Request Parameters

Field	Type	Required	Description
`owner`	Long	True	Account owning the task
`algoType`	Integer	True	任务组（30: "ASR", 31: "TTS"）
`billStartTime`	String	True	账单开始时间（格式为"YYYY-MM-DD HH:MM:SS"）
`billEndTime`	String	True	账单结束时间（格式为"YYYY-MM-DD HH:MM:SS"）
`algoSubType1`	String	True	PAAS_HTTP,PAAS_WS,PAAS_VIDEO_2D,PAAS_VIDEO_MIX,PAAS_LIVE
`algoSubType2`	String	True	ASR5, TTS3, TTS4, TTS5, TTS7, TTS8
`statRange`	String	True	Statistics range: 1 = Daily bill, 2 = Monthly bill
`pageNo`	int	False	Current page number (default 1)
`pageSize`	int	False	Items per page (default 10)
`sortName`	String	False	排序Field名
`sortValue`	String	False	Sort order: asc, desc

# Request Example

{
  "owner": 41,
  "algoType": "30",
  "billStartTime": "2024-12-04 00:00:00",
  "billEndTime": "2025-01-03 23:59:59",
  "statRange": 1,
  "algoSubType1": "",
  "algoSubType2": "",
  "pageSize": 10,
  "pageNo": 1,
  "sortName": "",
  "sortValue": ""
}

# Response Elements

Field	Type	Required	Description
`code`	Integer	True	0 - Success, Other - Error
`message`	String	True	Error details
`data`	Object	True	成功与否，成功是1 ，错误返回null
- `pagination`	Pagination	True	分页信息(参照通用数据结构Description)
- `result`	Object	True	Billing list (refer to description below)

账单列表

Field	Type	Required	Description
`id`	Long	True	Task ID
`owner`	Long	True	Account owning the task
`algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,17:互动直播, 44:视频直播）
`billingValue`	Integer	True	Billing value
`billingUnit`	Integer	True	计费单位（1:时长单位:毫秒,2：时长单位：秒,3：单位：数量)
`billingDate`	String	True	Billing date，格式为"YYYY-MM-DD"
`billingMonth`	String	False	Billing month
`algoSubType1`	String	True	PAAS_HTTP,PAAS_WS,PAAS_VIDEO_2D,PAAS_VIDEO_MIX,PAAS_LIVE
`algoSubType2`	String	True	ASR5, TTS3, TTS4, TTS5, TTS7, TTS8

# Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 4,
      "pageSize": 10,
      "startIndex": 0
    },
    "result": [
      {
        "id": 13635,
        "owner": 260,
        "billingValue": 0.0045,
        "billingUnit": 3,
        "billingDate": "2024-12-27",
        "billingMonth": null,
        "algoSubType1": "PAAS_VIDEO_MIX",
        "algoSubType2": "TTS5",
        "algoType": 31
      },
      {
        "id": 13631,
        "owner": 260,
        "billingValue": 0.0347,
        "billingUnit": 3,
        "billingDate": "2024-12-27",
        "billingMonth": null,
        "algoSubType1": "PAAS_VIDEO_2D",
        "algoSubType2": "TTS5",
        "algoType": 31
      },
      {
        "id": 12441,
        "owner": 260,
        "billingValue": 0.0347,
        "billingUnit": 3,
        "billingDate": "2024-12-06",
        "billingMonth": null,
        "algoSubType1": "PAAS_VIDEO_2D",
        "algoSubType2": "TTS5",
        "algoType": 31
      },
      {
        "id": 12433,
        "owner": 260,
        "billingValue": 0.0347,
        "billingUnit": 3,
        "billingDate": "2024-12-06",
        "billingMonth": null,
        "algoSubType1": "PAAS_VIDEO_2D",
        "algoSubType2": "TTS3",
        "algoType": 31
      }
    ]
  }
}

# Task Completion Callback Parameters

When using the API, the system will return task status and other information through the configured callback URL. To use the task callback feature, contact the administrator to provide the callback URL when creating the account. If the user has configured an AuthKey, authentication information including timestamp and signature will be returned. For details, refer to .

提供的接口实现中HTTP Method为POST，Content-Type应为application/json。

Field	Type	Required	Description
`taskId`	Integer	True	任务 id
`materialId`	Integer	True	Material ID
`materialName`	String	True	素材Name
`algoType`	Integer	True	任务Type（11:TTS音色模型生成,12:人物形象模型生成,14:视频合成,20: 视频人物换脸,18:人物形象模型更新，25:音色转换， 32:图片绿幕分割预览，33:视频绿幕分割预览，37:视频直播，41:TTS V3音色模型生成，42:口水话(快速答复库)，43:文件预热, 44:接管视频生成, 45:文件预热删除
`algoSubType1`	String	True	人物模型：模型规格：2K/4K，视频合成：使用人物模型规格：2K/4K
`algoSubType2`	String	False	视频合成：结果物格式：webm/mp4
`algoSubType3`	String	False	视频合成：结果帧率
`status`	Integer	True	状态 3:已取消，5:已完成，9:异常
`taskResult`	String	False	Error message

The above covers all algorithmic capabilities provided by the platform.

← User Access FAQ →