视频元素获取

API 公共请求参数

以下接口调用时， 请求参数必须携带API 公共请求参数，见 API 公共请求参数

一、获取背景音乐列表

调用此接口可获取合成AI视频所需背景音乐的相关信息。

HTTP 协议

使用 HTTPS 进行调用。

请求地址

/api/aigc/job/element/getBgAudioList

请求方法

HTTP POST 方法

请求参数

参数名称	类型	是否必填	示例值	说明
page	int	是	1	页码。 从1 开始
limit	int	是	10	返回个数。 最大取值为20

返回参数

参数名称	类型	示例值	说明
code	int	1	1 为成功，非 1 为失败，具体错误码见响应码
msg	string	SUCESS	返回消息
devMsg	string		开发调试使用
data	object		数据对象，json 对象。
- page	int	1	数据所在页
- limit	int	10	每页显示条数
- count	int	10	本次返回数据条数
- cursor	int		游标值
- total	int	200	服务器估算数据总条数
- hasMore	int	1	是否还有更多数据 1: 有更多数据 0：没有更多数据
- list	[]object		背景音乐数组数据
- audioID	string		音频数据 id
- title	string		背景音乐标题
- bgAudioID	string		背景音乐 id
- url	string		背景音乐资源 url 地址
requestID	string		请求id

调用示例

请求示例

curl --location 'openapi.yizhentv.com/api/aigc/job/element/getBgAudioList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appID={应用id}' \
--data-urlencode 'date=2023-7-5 18:22:50' \
--data-urlencode 'nonce=2cc80238-37e8-4a99-b803-eb0e2620eb2b' \
--data-urlencode 'signType=HMAC-SHA1' \
--data-urlencode 'signature={签名}' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=1'

返回示例

{
    "code": 1,
    "msg": "SUCCESS",
    "data": {
        "page": 1,
        "limit": 1,
        "count": 1,
        "cursor": 0,
        "total": 2330,
        "hasMore": 1,
        "list": [
            {
                "audioID": "1036626078338192",
                "title": "chinese-new-year-130465",
                "bgAudioID": "9",
                "url": "https://n1cdnaudio.miaopai.com/stream/ys7vJQT4tZQHFhk77iAGq1M7SqalwlHy0rCGSg___2.mp3?ssig=92b25f0aa3a36cb50355cebd89bba36f&time_stamp=1693833648173"
            }
        ]
    },
    "requestID": "91f4da15-4af3-11ee-a7d8-da639a01edb2"
}

二、获取配音列表

调用此接口可获取合成AI视频所需配音的相关信息。

HTTP 协议

使用 HTTPS 进行调用。

请求地址

/api/aigc/job/element/getNarratorList

请求方法

HTTP POST 方法

请求参数

参数名称	类型	是否必填	示例值	说明
page	int	是	1	页码。 从1 开始
limit	int	是	10	返回个数。 最大取值为20

返回参数

参数名称	类型	示例值	说明
code	int	1	1 为成功，非 1 为失败，具体错误码见响应码
msg	string	SUCESS	返回消息
devMsg	string		开发调试使用
data	object		数据对象，json 对象。
- page	int	1	数据所在页
- limit	int	10	每页显示条数
- count	int	10	本次返回数据条数
- cursor	int		游标值
- total	int	200	服务器估算数据总条数
- hasMore	int	1	是否还有更多数据 1: 有更多数据 0：没有更多数据
- list	[]object		配音数组数据
- name	string		配音名字
- narratorID	string		配音 id
- describe	string		配音描述
- audios	[]object		配音样音数组
- mediaID	string		音频数据 id
- key	string		音频数据key
- items	[]object		试听音频数组
- url	string		资源地址
- name	string		语速
- speed	float		语速
- duration	int		持续时间（毫秒）
requestID	string		请求id

调用示例

请求示例

curl --location 'https://openapi.yizhentv.com/api/aigc/job/element/getNarratorList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appID={应用 id}' \
--data-urlencode 'date=2023-7-5 18:22:50' \
--data-urlencode 'nonce=2cc80238-37e8-4a99-b803-eb0e2620eb2b' \
--data-urlencode 'signType=HMAC-SHA1' \
--data-urlencode 'signature={签名}' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=1'

返回示例

{
    "code": 1,
    "msg": "SUCCESS",
    "data": {
        "page": 1,
        "limit": 1,
        "count": 1,
        "cursor": 0,
        "total": 64,
        "hasMore": 1,
        "list": [
            {
                "name": "臻云希",
                "narratorID": "3",
                "describe": "影视解说、自然动听",
                "audios": [
                    {
                        "mediaID": "0",
                        "key": "YWsvzA8lcLm16XXHTIGWm15iSxCjV0l3",
                        "timbre": 1,
                        "timbreDesc": "默认",
                        "status": 1,
                        "items": [
                            {
                                "audioID": "6973908621914603520",
                                "url": "https://n1cdnaudio.miaopai.com/audio/FErEdh0AdRZ7plxLi8tNeVcryR-H7OOaJp7noA___1662709384.mp3?ssig=a8a8fc91d645c92925e7ff3611beddac&time_stamp=1693835503293",
                                "duration": 27000,
                                "name": "0.8",
                                "speed": 0.8
                            },
                            {
                                "audioID": "6973908620492734464",
                                "url": "https://n1cdnaudio.miaopai.com/audio/OakCkTWdPWNxgBgSbSreg4PUtDBWCvOZdzc-EA___1662709384.mp3?ssig=45ab5b51f7a9a57c57c992aaf147edaa&time_stamp=1693835503293",
                                "duration": 24000,
                                "name": "0.9",
                                "speed": 0.9
                            },
                            {
                                "audioID": "6973908629682515968",
                                "url": "https://n1cdnaudio.miaopai.com/audio/ALouBMo0X0PUy0Hn5vvFogQlfyOAYpKWSPxe6Q___1662709386.mp3?ssig=85c644efc0d25cb310d20287356e7e48&time_stamp=1693835503293",
                                "duration": 21000,
                                "name": "正常",
                                "speed": 1
                            },
                            {
                                "audioID": "6973908620203388928",
                                "url": "https://n1cdnaudio.miaopai.com/audio/7kCls059hlcBOIKlBm~qJZrxGCdipvQVeSC8ZQ___1662709384.mp3?ssig=bf97c2598ba1a5eacaba04bfbb0805e0&time_stamp=1693835503293",
                                "duration": 19000,
                                "name": "1.1",
                                "speed": 1.1
                            },
                            {
                                "audioID": "6973908620161445888",
                                "url": "https://n1cdnaudio.miaopai.com/audio/H5cp3Pih4ANxHX2tBlS-FDnZgw4G1SjMUbVgNQ___1662709384.mp3?ssig=634483129a2faefe892ba92f5584c53b&time_stamp=1693835503292",
                                "duration": 16000,
                                "name": "1.3",
                                "speed": 1.3
                            },
                            {
                                "audioID": "6973908619662262272",
                                "url": "https://n1cdnaudio.miaopai.com/audio/jnbe9X~TlRXfAUH946QjBZR6tY8r7aG5nlf87w___1662709384.mp3?ssig=422c7072a206ce5671120589a62e3e50&time_stamp=1693835503293",
                                "duration": 14000,
                                "name": "1.5",
                                "speed": 1.5
                            }
                        ],
                        "default": 1
                    }
                ]
            }
        ]
    },
    "requestID": "e3a9577b-4af7-11ee-a9e5-e2d2087239a4"
}

三、获取背景列表

调用此接口可获取合成AI视频所需背景的相关信息。

HTTP 协议

使用 HTTPS 进行调用。

请求地址

/api/aigc/job/element/getBackgroundList

请求方法

HTTP POST 方法

请求参数

参数名称	类型	是否必填	示例值	说明
page	int	是	1	页码。 从1 开始
limit	int	是	10	返回个数。 最大取值为20

返回参数

参数名称	类型	示例值	说明
code	int	1	1 为成功，非 1 为失败，具体错误码见响应码
msg	string	SUCESS	返回消息
devMsg	string		开发调试使用
data	object		数据对象，json 对象。
- page	int	1	数据所在页
- limit	int	10	每页显示条数
- count	int	10	本次返回数据条数
- cursor	int		游标值
- total	int	200	服务器估算数据总条数
- hasMore	int	1	是否还有更多数据 1: 有更多数据 0：没有更多数据
- list	[]object		背景数组数据
- templateID	string		背景模板 id
- name	string		背景名字
- url	string		资源 url 地址
requestID	string		请求id

调用示例

请求示例

curl --location 'openapi.yizhentv.com/api/aigc/job/element/getBackgroundList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appID={应用id}' \
--data-urlencode 'date=2023-7-5 18:22:50' \
--data-urlencode 'nonce=2cc80238-37e8-4a99-b803-eb0e2620eb2b' \
--data-urlencode 'signType=HMAC-SHA1' \
--data-urlencode 'signature={签名}' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=1'

返回示例

{
    "code": 1,
    "msg": "SUCCESS",
    "data": {
        "page": 1,
        "limit": 1,
        "count": 1,
        "cursor": 0,
        "total": 36,
        "hasMore": 0,
        "list": [
            {
                "templateID": "99939827507455333",
                "name": "国风（横）",
                "url": "https://imgaliyuncdn.miaopai.com/stream/image/XecW9mKfaG117wWlvpdj2FDiWThSPGk.jpg"
            }
        ]
    },
    "requestID": "76229b8b-4afa-11ee-a9e5-e2d2087239a4"
}

四、获取字幕风格列表

调用此接口可获取合成AI视频所需字幕风格的相关信息。

HTTP 协议

使用 HTTPS 进行调用。

请求地址

/api/aigc/job/element/getSubtitleList

请求方法

HTTP POST 方法

请求参数

无

返回参数

参数名称	类型	示例值	说明
code	int	1	1 为成功，非 1 为失败，具体错误码见响应码
msg	string	SUCESS	返回消息
devMsg	string		开发调试使用
data	object		数据对象，json 对象。
- page	int	1	数据所在页
- limit	int	10	每页显示条数
- count	int	10	本次返回数据条数
- cursor	int		游标值
- total	int	200	服务器估算数据总条数
- hasMore	int	1	是否还有更多数据 1: 有更多数据 0：没有更多数据
- list	[]object		背景数组数据
- subtitleID	string		字幕样式id
- title	string		字幕样式名字
- url	string		资源 url 地址
requestID	string		请求id

调用示例

请求示例

curl --location 'openapi.yizhentv.com/api/aigc/job/element/getSubtitleList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appID={应用id}' \
--data-urlencode 'date=2023-7-5 18:22:50' \
--data-urlencode 'nonce=2cc80238-37e8-4a99-b803-eb0e2620eb2b' \
--data-urlencode 'signType=HMAC-SHA1' \
--data-urlencode 'signature={签名}' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=1'

返回示例

{
    "code": 1,
    "msg": "SUCCESS",
    "data": {
        "list": [
            {
                "subtitleID": 1,
                "title": "默认字幕",
                "url": "https://imgaliyuncdn.miaopai.com/stream/image/wDRBHsc4pW6SjeGkfnOf4xh4lcN4rE8.jpg"
            },
            {
                "subtitleID": 9,
                "title": "字幕样式",
                "url": "http://qncdn-miaopai.oss-cn-beijing.aliyuncs.com/stream/image/9jaJheRnTdx8cGiVB9UvgFW4CSwlO3k.jpg"
            }
        ]
    },
    "requestID": "fea2d77c-4afa-11ee-a9e5-e2d2087239a4"
}

五、获取用户素材列表

调用此接口可获取合成AI视频所需片头、片尾的相关信息。

HTTP 协议

使用 HTTPS 进行调用。

请求地址

/api/aigc/job/element/getUserMaterialList

请求方法

HTTP POST 方法

请求参数

参数名称	类型	是否必填	示例值	说明
page	int	是	1	页码。 从1 开始
limit	int	是	10	返回个数。 最大取值为20

返回参数

参数名称	类型	示例值	说明
code	int	1	1 为成功，非 1 为失败，具体错误码见响应码
msg	string	SUCESS	返回消息
devMsg	string		开发调试使用
data	object		数据对象，json 对象。
- page	int	1	数据所在页
- limit	int	10	每页显示条数
- count	int	10	本次返回数据条数
- cursor	int		游标值
- total	int	200	服务器估算数据总条数
- hasMore	int	1	是否还有更多数据 1: 有更多数据 0：没有更多数据
- list	[]object		素材数组数据
- mediaID	string		素材数据 id
- duration	string		持续时间(毫秒)
- materialType	string		素材类型 1：视频 2：图片
- title	string		资源
- url	string		资源 url 地址
requestID	string		请求id

调用示例

请求示例

curl --location 'openapi.yizhentv.com/api/aigc/job/element/getUserMaterialList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appID={应用id}' \
--data-urlencode 'date=2023-7-5 18:22:50' \
--data-urlencode 'nonce=2cc80238-37e8-4a99-b803-eb0e2620eb2b' \
--data-urlencode 'signType=HMAC-SHA1' \
--data-urlencode 'signature={签名}' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=1'

返回示例

{
    "code": 1,
    "msg": "SUCCESS",
    "data": {
        "page": 1,
        "limit": 1,
        "count": 1,
        "cursor": 0,
        "total": 20,
        "hasMore": 1,
        "list": [
            {
                "mediaID": "301196607941551161",
                "duration": 0,
                "materialType": 2,
                "picture": "https://imgaliyuncdn.miaopai.com/aivideo/598c7dedfb213b83e06b49447583a8b7.jpg",
                "title": "样例1",
                "url": "https://imgaliyuncdn.miaopai.com/aivideo/598c7dedfb213b83e06b49447583a8b5.jpg"
            }
        ]
    },
    "requestID": "0ad61b6a-4afe-11ee-a9e5-e2d2087239a4"
}

六、获取 Logo 模板列表

调用此接口可获取合成AI视频所需 logo 的相关信息。

HTTP 协议

使用 HTTPS 进行调用。

请求地址

/api/aigc/job/element/getUserLogoTemplateList

请求方法

HTTP POST 方法

请求参数

参数名称	类型	是否必填	示例值	说明
page	int	是	1	页码。 从1 开始
limit	int	是	10	返回个数。 最大取值为20

返回参数

参数名称	类型	示例值	说明
code	int	1	1 为成功，非 1 为失败，具体错误码见响应码
msg	string	SUCESS	返回消息
devMsg	string		开发调试使用
data	object		数据对象，json 对象。
- page	int	1	数据所在页
- limit	int	10	每页显示条数
- count	int	10	本次返回数据条数
- cursor	int		游标值
- total	int	200	服务器估算数据总条数
- hasMore	int	1	是否还有更多数据 1: 有更多数据 0：没有更多数据
- list	[]object		背景数组数据
- templateID	string		logo 模板 id
- logoType	int	1	logo 类型 1: 文字 2：图片
- title	string		logo 名字
- url	string		logo 类型时，图片资源地址
requestID	string		请求id

调用示例

请求示例

curl --location 'openapi.yizhentv.com/api/aigc/job/element/getUserLogoTemplateList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appID={应用id}' \
--data-urlencode 'date=2023-7-5 18:22:50' \
--data-urlencode 'nonce=2cc80238-37e8-4a99-b803-eb0e2620eb2b' \
--data-urlencode 'signType=HMAC-SHA1' \
--data-urlencode 'signature={签名}' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=1'

返回示例

{
    "code": 1,
    "msg": "SUCCESS",
    "data": {
        "page": 1,
        "limit": 1,
        "count": 1,
        "cursor": 0,
        "total": 2,
        "hasMore": 1,
        "list": [
            {
                "templateID": "53",
                "title": "Syb"
            }
        ]
    },
    "requestID": "6e549282-4b09-11ee-b877-d23f3704d88a"
}