查询作品(任务)详情

1.接口说明

请求该接口查询作品(任务)详情数据。

2.请求地址

https://digitbot.bokecc.com/api/product/get

3.请求方式

GET

4.请求参数

(1).公共参数，参考服务说明。

(2).接口参数

①.Query参数：通过URL参数传递。

参数名	类型	必需	说明
version	String	是	接口版本号，当前支持版本：1.0.0、1.2.0、1.3.0、1.4.0、1.5.0
projectId	String	是	项目ID。
productId	String	是	作品ID。

5.请求示例

GET https://digitbot.bokecc.com/api/product/get?projectId=xxx&productId=xxx&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1

6.响应示例

{
   	"id": "xxx",
    "type": 0,
    "name": "示例作品",
    "projectId": "xxx",
    "projectName": "演示项目",
    "projectStatus": 0,
    "videoWidth": 1920,
    "videoHeight": 1080,
    "videoAspect": "16:9",
    "duration": 1234567,
    "status": 0,
    "progress": 30,
    "createTime": "2024-01-24 09:10:11",
    "finishTime": "2024-01-24 10:00:00",
    "expireDate": "2024-02-23",
    "previewUrl": "https://xxxxx.xxxxx",
    "scenes": [{
        "orderNo": 1,
        "driverType": 0,
        "duration": 12434,
        "status": 0,
        "progress": 10,
        "finishTime": "2024-01-24 09:30:22",
        "textDriver": {
            "text": "这是一段测试文本，welcome to HuoDe digitbot。",
            "speed": 1.00,
            "volume": 1.0,
            "invalidContent": "xxxxx"
        },
        "audioDriver": {
			"useUrl": true,
            "audioId": "xxx",
            "filename": "xxx",
			"audioUrl": "https://xxxxxxx",
            "duration": 12434
        },
        "portraitModel": {
            "type": 1,
			"useUrl": false,
            "modelId": "xxx",
            "name": "xxx",
			"customType": 2,
			"facialFeature": 1
        },
        "voiceModel": {
            "type": 1,
            "modelId": "xxx",
            "name": "xxx",
            "voiceStyleId": "xxx"
        },
        "background": {
            "type": 1,
            "color": "",
			"useUrl": false,
            "backgroundId": "xxx",
			"imageUrl": "https://xxxx.xxx",
            "videoUrl": "https://xxxx.xxxx",
			"originWidth": 2920,
			"originHeight": 2080,
			"width": 1920,
			"height": 1190,
            "videoDuration": 1234563
        },
        "stickers": [{
            "type": 1,
			"useUrl": false,
            "stickerId": "xxx"
        }, ...],
        "coordinates": [{
            "type": 1,
			"useUrl": false,
            "entityId": "xxx",
			"entityIndex": 0,
            "previewUrl": "https://xxxxxx",
            "originWidth": 752,
            "originHeight": 1998,
            "width": 376,
            "height": 999,
            "x": 30,
            "y": 50,
            "position": 0
        }, ...],
        "subtitles": [{
            "indexNo": 1,
            "startTimestamp": 1029,
            "endTimestamp": 3091,
            "text": "这是一行示例字幕，由上传的音频驱动素材转写生成。"
        }, ...]
    }, ...],
    "subtitlesStyle": {
        "fontname": "PangMenZhengDao",
        "fontsize": 65,
        "primaryColor": "#9326FA",
        "outlineColor": "#D0EEFF",
        "backgroundColor": "#FFDE00",
        "backgroundAlpha": 35,
        "alignment": 2,
        "marginLeft": 40,
        "marginRight": 40,
        "marginBottom": 130
    },
	"memberId": "xxx"
}

7.响应说明

字段名	类型	说明	版本说明
id	String	作品(任务)ID。
type	Integer	作品类型，枚举值。0=视频；1=音频。
name	String	作品名称。
projectId	String	项目ID。
projectName	String	项目名称。
projectStatus	Integer	项目状态，枚举值。0=正常；1=已删除。
videoWidth	Integer	视频宽度，像素值。
videoHeight	Integer	视频高度，像素值。
videoAspect	String	视频比例，宽高比，w:h格式。
duration	Long	作品时长，单位：毫秒。
status	Integer	作品(任务)状态，枚举值。1=审核中；2=内容违规(审核不通过)；3=合成中；4=合成失败；5=合成成功；6=已过期。
progress	Integer	作品(任务)进度，取值[-1, 100]区间，-1表示排队中；0~100表示进度的百分比。status=3时有效。
createTime	String	作品(任务)创建时间，yyyy-MM-dd HH:mm:ss格式。
finishTime	String	作品(任务)完成时间，yyyy-MM-dd HH:mm:ss格式。
expireDate	String	作品过期日期，yyyy-MM-dd格式。超过该日期后作品过期，预览地址不可访问。status=5、6时有效。
previewUrl	String	作品预览链接。status=5时有效。
scenes	Array	作品(任务)合成时的场景(scene)列表，按顺序排列。
subtitlesStyle	Object	作品(任务)合成时应用的字幕样式。
memberId	String	第三方成员ID，iframe方式使用时特有。	1.2.0：新增返回内容
tailFrameUrl	String	视频结尾帧图片链接。	2025-12-24：新增

• duration：作品时长，作品(任务)处理成功后，按合成的结果时长返回，否则按预估时长返回。

scene字段说明

字段名	类型	说明
orderNo	Integer	场景编号，从1开始，按顺序递增。
driverType	Integer	驱动类型，枚举值。0=文本驱动；1=音频驱动。
duration	Long	场景时长，单位：毫秒。
status	Integer	场景(任务)状态，枚举值。1=审核中；2=内容违规(审核不通过)；3=合成中；4=合成失败；5=合成成功。
progress	Integer	场景(任务)进度，取值[-1, 100]区间，-1表示排队中；0~100表示进度的百分比。status=3时有效。
finishTime	String	场景(任务)完成时间，yyyy-MM-dd HH:mm:ss格式。
textDriver	Object	文本驱动内容。driverType=0时有效。
audioDriver	Object	音频驱动内容。driverType=1时有效。
portraitModel	Object	人像模型信息。
voiceModel	Object	声音模型信息。
background	Object	场景背景信息。
stickers	Array	场景中应用的贴纸(sticker)列表，包括图片、PPT、线条等。
coordinates	Array	场景中应用部件的坐标信息(coordinate)列表，按由远及近顺序排列，包括人像、贴纸等。
subtitles	Array	字幕(subtitle)列表，按字幕顺序排列。

• duration：场景时长，场景(任务)处理成功后，按合成的结果时长返回，否则按预估时长返回。

scene.textDriver字段说明

字段名	类型	说明	版本说明
text	String	文本内容。JSON格式文本，参考 附2.JSON格式文本说明。	1.5.0之前：返回纯文本内容1.5.0起：返回JSON格式文本内容
speed	Float	文本生成声音内容时的语速倍数。取值在[0.6, 1.5]区间内，1.0表示标准语速。
volume	Float	文本生成声音内容时的音量。取值在[1.0, 2.0]区间内，1.0表示正常音量，2.0表示最大音量。
invalidContent	String	违规文本内容。scene.status=2时有效。

scene.audioDriver字段说明

字段名	类型	说明	版本说明
audioId	String	用户上传的驱动音频素材ID。useUrl=false时有效。
filename	String	用户上传的驱动音频素材文件名，包含后缀名。useUrl=false时有效。
duration	Long	驱动音频时长，单位：毫秒。useUrl=false时，表示audioId关联的的音频素材时长。useUrl=true时，表示音频素材链接对应的音频素材时长。	1.4.0起：兼容素材链接参数
useUrl	Boolean	是否使用驱动音频素材链接，true表示使用。	1.4.0：新增返回内容
audioUrl	String	驱动音频素材链接。useUrl=true时有效。	1.4.0：新增返回内容

scene.portraitModel字段说明

字段名	类型	说明	版本说明
type	Integer	人像模型类型，枚举值。0=模特人像；1=自定义人像。
modelId	String	人像模型ID。useUrl=false时有效。
name	String	人像模型名称。useUrl=false时有效。
customType	Integer	人像模型定制类型，枚举值。0=专属口型人像；2=图片数字人；4=通用口型人像；7=图文数字人。	1.3.0：新增返回内容。2025-11-17：扩展类型-7。
useUrl	Boolean	是否使用数字人素材链接（图片数字人/图文数字人），true表示使用。	1.4.0：新增返回内容。2025-11-17：变更。
facialFeature	Integer	图片数字人面部特征，枚举值。1=真人；2=卡通。	1.4.0：新增返回内容
promptType	Integer	图文数字人模型提示词类型，枚举值。0=自定义提示词；1=系统内置说话模式提示词；2=系统内置唱歌模式提示词。	2025-11-17：新增。
promptText	String	图文数字人自定义模型提示词。promptType=0时有效。	2025-11-17：新增。
negativePrompt	String	图文数字人负面提示词。	2025-11-17：新增。
matting	Integer	图文数字人是否抠图，枚举值。0=不抠图；1=绿幕抠图；2=实景抠图。	2025-12-24：新增。

scene.voiceModel字段说明

字段名	类型	说明
type	Integer	声音模型类型，枚举值。0=AI声音；1=自定义声音。
modelId	String	声音模型ID。
name	String	声音模型名称。
voiceStyleId	String	声音风格ID。

scene.background字段说明

字段名	类型	说明	版本说明
type	Integer	背景类型，枚举值。0=颜色背景；1=图片背景；2=视频背景。
color	String	背景颜色，值为十六进制RGB颜色代码，RRGGBB或#RRGGBB格式。type=0时有效。
useUrl	Boolean	是否使用背景素材链接，true表示使用。	1.4.0：新增返回内容
backgroundId	String	背景素材ID，type!=0且useUrl=false时有效。
imageUrl	String	背景图片素材链接，type!=0时有效。type=1时，表示背景图片链接。type=2时，若useUrl=false，表示视频背景的封面截图链接；若useUrl=true，无内容。	1.4.0起：兼容素材链接参数
originWidth	Integer	背景素材原始宽，像素值，type!=0时有效。	1.4.0起：兼容素材链接参数
originHeight	Integer	背景素材原始高，像素值，type!=0时有效。	1.4.0起：兼容素材链接参数
width	Integer	背景素材目标宽，像素值。背景铺满视频画布后的素材宽度。颜色背景的目标宽度就是视频宽度。
height	Integer	背景素材目标高，像素值。背景铺满视频画布后的素材高度。颜色背景的目标高度就是视频高度。
videoUrl	String	视频背景素材链接。type=2时有效。	1.4.0起：兼容素材链接参数
videoDuration	Long	视频背景素材时长，单位：毫秒。type=2时有效。	1.4.0起：兼容素材链接参数

scene.sticker字段说明

字段名	类型	说明	版本说明
type	Integer	贴纸类型，枚举值。0=图片贴纸；1=PPT贴纸；2=线条贴纸。
useUrl	Boolean	是否使用图片贴纸素材链接，true表示使用。	1.4.0：新增返回内容
stickerId	String	贴纸素材ID。useUrl=false时有效。

scene.coordinate字段说明

字段名	类型	说明	版本说明
type	Integer	部件类型，枚举值。1=人像；21=图片贴纸；22=PPT贴纸；23=线条贴纸。
useUrl	Boolean	部件是否使用素材链接，true表示使用。	1.4.0：新增返回内容
entityId	String	部件素材ID。useUrl=false时有效。
entityIndex	Integer	部件索引编号。useUrl=true时有效。type=1：场景中只有一个人像，返回固定值0。type=21，对应图片贴纸在scene.stickers数组中的下标索引，从0开始计算。	1.4.0：新增返回内容
previewUrl	String	部件预览链接。type=1时，表示人像缩略图预览链接；type=21、22、23时，表示对应贴纸图片预览链接。	1.4.0起：兼容素材链接参数
originWidth	Integer	部件素材原始宽度，像素值。	1.4.0起：兼容素材链接参数
originHeight	Integer	部件素材原始高度，像素值。	1.4.0起：兼容素材链接参数
width	Integer	部件素材目标宽度，像素值。指在输出视频中，部件经过缩放后的宽度。
height	Integer	部件素材目标高度，像素值。指在输出视频中，部件经过缩放后的高度。
x	Integer	部件坐标x，像素值。指在输出视频中，部件的水平方向位置。以视频左上角为原点，部件左上角顶点定位，即部件左上角到视频左上角的水平距离。
y	Integer	部件坐标y，像素值。指在输出视频中，部件的垂直方向位置。以视频左上角为原点，部件左上角顶点定位，即部件左上角到视频左上角的垂直距离。
position	Integer	文本驱动场景中，部件在文本中标记的位置。

scene.subtitle字段说明

字段名	类型	说明
indexNo	Integer	字幕编号，从1开始，按顺序递增。
startTimestamp	Long	字幕开始时间戳，单位：毫秒。
endTimestamp	Long	字幕结束时间戳，单位：毫秒。
text	String	字幕内容。

subtitlesStyle字段说明

字段名	类型	说明
fontname	String	字体名称。
fontsize	Integer	字体大小，像素值，取值范围为[12, 100]区间。
primaryColor	String	文字颜色，值为十六进制RGB颜色代码，支持RRGGBB或#RRGGBB格式。
outlineColor	String	文字边框颜色，值为十六进制RGB颜色代码，支持RRGGBB或#RRGGBB格式。
backgroundColor	String	文字背景颜色，值为十六进制RGB颜色代码，支持RRGGBB或#RRGGBB格式。
backgroundAlpha	Integer	文字背景透明度，取值范围为[0, 100]区间，0表示透明；100表示不透明。
alignment	Integer	文字对齐方式，枚举值。1=左对齐；2=居中；3=右对齐。
marginLeft	Integer	字幕左边距，像素值。第一个文字到视频画布左边界的水平距离。
marginRight	Integer	字幕右边距，像素值。最后一个文字到视频画布右边界的水平距离。
marginBottom	Integer	字幕下边距，像素值。字幕区域底部到视频画布下边界的垂直距离。