# Public Material Acquisition

The video synthesis service provides you with the option to select a 2D digital human figure model, add text or audio to synthesize it into a 2D virtual digital human mp4 video. The platform offers public material content for users who join the platform, helping users quickly generate content. The public materials include several digital human character models, TTS personal voice models, and video templates.

# Material Introduction

Digital Human Character Models
- 2D digital human figures needed during the video synthesis phase. The platform provides several public 2D digital human figure models for users to acquire and choose from. For details, please contact the operation to open an account and view.
TTS Personal Voice Models
- Personal voice models include the voice tone of the speaker, as well as information on the speed, pitch, and volume of the voice. The platform provides multiple default TTS personal voice models for users to choose from. The selected voice model will read the corresponding text content, and this audio will ultimately be used for video synthesis.
Video Templates
- Video templates refer to the background in which the character is situated, the foreground content displayed in front of the character, and the position, font, and size of the text appearing in the video. All this information is uniformly recorded in the video template.

# API Documentation

To access all API services of the platform, users must visit the service access point: aigc.softsugar.com, and add token information in the request header.

# Retrieve Full Public Figure Image Models

# Interface Description

Returns a paginated list of all public figure image models.

# 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	Number of items per page (default 10)
`sortName`	String	False	Field name for sorting
`sortValue`	String	False	Sorting order: asc, desc

# Request Example

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

Field	Type	Required	Description
`code`	Number	True	0 - Success, others - Error
`message`	String	True	Detailed error information
`data`	Object	False	Data object, usually empty on error
- `pagination`	Pagination	True	Pagination information (refer to common explanation)
- `result`	Array	False	Public figure model (refer to the explanation below)

Public Figure Model

Field	Type	Required	Description
`id`	Long	True	Model ID
`materialName`	String	True	Material name
`thumbnailUrl`	String	True	Thumbnail Url
`pkgUrl`	String	True	Model material package url
`extendParam`	String	False	Character configuration in JSON format (refer to the explanation below)
`desc`	String	False	Remarks
`createTime`	String	True	Creation time, yyyy-MM-dd HH:mm:ss
`updateTime`	String	True	Last update time, yyyy-MM-dd HH:mm:ss

extendParam for Character Model Parameters

Field	Type	Required	Description
`faceFeatureId`	String	True	faceFeatureId

# Response Example

{
    "code": 0,
    "message": "success",
    "data": {
        "pagination": {
                "pageNo": 1,
                "numberPages": 1,
                "numberRecords": 10,
                "pageSize": 10,
                "startIndex": 0
            },
        "result": [{
            "id": 2221738,
            "materialName": "Public Figure Image ",
            "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": "Public Figure Image 2",
            "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
            "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.zip",
            "extendParam": "{\"faceFeatureId\": \"123\"}",
            "desc": null,
            "createTime": "2022-09-06 19:10:09",
            "updateTime": "2022-10-28 16:59:18"
        }]
    }
}

# Obtain Specified Public Figure Image Models

# Interface Description

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

# Request URL

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

# Request Header

Content-Type: application/json

# Request Parameters

Field	Type	Required	Description
`ids`	Long[]	True	Array of public figure image model IDs

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

| Field              | Type    | Required | Description                            |
|--------------------|---------|----------|----------------------------------------|
| `code`             | Number  | True     | 0 - Success, others - Error            |
| `message`          | String  | True     | Detailed error information             |
| `data`             | Array   | False    | Usually empty in case of error         |
|   - `id`           | Long    | True     | Model ID                               |
|   - `materialName` | String  | True     | Material name                          |
|   - `thumbnailUrl` | String  | True     | Thumbnail Url                          |
|   - `pkgUrl`       | String  | True     | Model material package url             |
|   - `extendParam`  | String  | False    | Character image parameter configuration, Json format (refer to the explanation below) |
|   - `desc`         | String  | False    | Remarks                                |
|   - `createTime`   | String  | True     | Creation time, yyyy-MM-dd HH:mm:ss     |
|   - `updateTime`   | String  | True     | Last update time, yyyy-MM-dd HH:mm:ss  |

**Character Image Model Parameter Information in extendParam**

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

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "Public Figure Image 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": "Public Figure Image 2",
    "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
    "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.zip",
    "extendParam": "{\"faceFeatureId\": \"123\"}",
    "desc": null,
    "createTime": "2022-09-06 19:10:09",
    "updateTime": "2022-10-28 16:59:18"
  }]
}

# Retrieve Full List of Public TTS Personal Voice Models

# Interface Description

Returns a list of all public TTS personal voice models in pages.

# 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	Number of items per page (default 10)
`sortName`	String	False	Name of the sorting field
`sortValue`	String	False	Sorting order: asc, desc

# Request Example

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

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, others - Error
`message`	String	True	Detailed error message
`data`	Object	False	data object, usually empty in case of error
- `pagination`	Pagination	True	Pagination information (refer to common description)
- `result`	Array	False	Public TTS personal voice models (refer to the description below)

Public TTS Personal Voice Models

Field	Type	Required	Description
`id`	Long	True	Model ID
`extendParam`	String	True	Json string of ttsConfig, recording TTS parameter information (refer to the description below)
`materialName`	String	True	Material name
`thumbnailUrl`	String	True	Thumbnail Url
`desc`	String	False	Remarks
`createTime`	String	True	Creation time, yyyy-MM-dd HH:mm:ss
`updateTime`	String	True	Last update time, yyyy-MM-dd HH:mm:ss

TTS Parameter Information in extendParam

Field	Type	Required	Description
`vendorId`	Integer	True	vendorId
`voiceId`	String	True	Voice ID
`voiceName`	String	True	Voice name
`language`	String	True	Language
`speedRatio`	Integer	True	Speech speed
`pitchOffset`	Integer	True	Pitch
`volume`	Integer	True	Volume
`sampleUrl`	String	False	Trial Listening URL

# 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": "Public TTS Personal Voice Model 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": "Public TTS Personal Voice Model 2",
        "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
        "desc": null,
        "createTime": "2022-09-06 19:10:09",
        "updateTime": "2022-10-28 16:59:18"
      }
    ]
  }
}

# Retrieve Specified Public TTS Personal Voice Models

# Interface Description

Returns the specified public TTS personal voice model 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	Array of model IDs

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, Others - Error
`message`	String	True	Detailed error message
`data`	Array	False	Usually empty in case of an error
- `id`	Long	True	Model ID
- `extendParam`	String	True	Json string of ttsConfig, recording TTS parameter info (see below)
- `materialName`	String	True	Material name
- `thumbnailUrl`	String	True	Thumbnail URL
- `desc`	String	False	Remarks
- `createTime`	String	True	Creation time, yyyy-MM-dd HH:mm:ss
- `updateTime`	String	True	Last update time, yyyy-MM-dd HH:mm:ss

TTS Parameter Info in extendParam

Field	Type	Required	Description
`vendorId`	Integer	True	vendorId
`voiceId`	String	True	Voice ID
`voiceName`	String	True	Voice name
`language`	String	True	Language
`speedRatio`	Integer	True	Speed
`pitchOffset`	Integer	True	Pitch
`volume`	Integer	True	Volume
`sampleUrl`	String	False	Trial Listening URL

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 13,
      "extendParam": {
        "voiceId": "ttsId1",
        "speedRatio": 4,
        "pitchOffset": 1,
        "volume": 100
      },
      "materialName": "Public Role TTS Voice Model 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": "Public Role TTS Voice Model 2",
      "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
      "desc": null,
      "createTime": "2022-09-06 19:10:09",
      "updateTime": "2022-10-28 16:59:18"
    }
  ]
}

# Retrieve All Public Video Templates

# Interface Description

Returns a paginated list of all public video templates.

# 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	Number of items per page (default 10)
`sortName`	String	False	Field name to sort by
`sortValue`	String	False	Sort order: asc, desc

# Request Example

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

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Others - Error
`message`	String	True	Detailed error message
`data`	Object	False	data object, usually empty in case of error
- `pagination`	Pagination	True	Pagination information (refer to common description)
- `result`	Array	False	Public video templates (refer to the description below)

Public Video Templates

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	Sample video URL
`desc`	String	False	Remarks
`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": "Public Video Template 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": "Public Video Template 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"
        }]
    }
}

# Retrieve Specified Public Video Templates

# Interface Description

Returns the specified public video templates based on the 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	Array of video template IDs

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, others - Error
`message`	String	True	Detailed error information
`data`	Array	False	Usually null in case of an 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	Remarks
- `createTime`	String	True	Creation time, yyyy-MM-dd HH:mm:ss
- `updateTime`	String	True	Last updated time, yyyy-MM-dd HH:mm:ss

# Response Example

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "Public Video Template 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": "Public Video Template 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"
  }]
}

# Retrieve the Complete List of Public Live Scripts

# Interface Description

Returns a paginated list of all public live 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	Number of items per page (default 10)
`sortName`	String	False	Name of the sorting field
`sortValue`	String	False	Sorting order: asc, desc

# Request Example

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

# Response Elements

Field	Type	Required	Description
`code`	Number	True	0 - Success, Others - Error
`message`	String	True	Detailed error message
`data`	Object	False	data object, usually null on error
- `pagination`	Pagination	True	Pagination information (see common description)
- `result`	Array	False	List of public live scripts (see below for details)

Public Video Templates

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 currently
`desc`	String	False	Remarks
`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": "Public Live Broadcast Script 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": "Public Live Broadcast Script 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"
        }]
    }
}

# Fetching Specified Public Live Script

# Interface Description

Returns the specified public live script based on the 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	Array of live script IDs

# Request Example

{
  "ids": [13,16]
}

# Response Parameters

Field	Type	Required	Description
`code`	Number	True	0 - Success, others - Error
`message`	String	True	Detailed error information
`data`	Array	False	Usually empty in case of an error
- `id`	Long	True	Script ID
- `materialName`	String	True	Name of the live script
- `thumbnailUrl`	String	True	Thumbnail Url
- `pkgUrl`	String	True	URL of the script material package
- `extendUrl`	String	True	Not available
- `desc`	String	False	Remarks
- `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": "Public Live Broadcast Script 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": "Public Live Broadcast Script 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"
  }]
}

The above is the related content of public materials that the platform can provide for video synthesis tasks.

← User Access Speech Processing →