文档中心

即梦AI

小云雀-短剧漫剧Agent

小云雀-短剧漫剧Agent-图片生成-接口文档

接入说明

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

提交任务

提交任务请求参数

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31

参数	类型	可选/必选	说明
Action	string	必选	接口名，取值：CVSync2AsyncSubmitTask
Version	string	必选	版本号，取值：2022-08-31

Header参数

注意

本服务固定值：Region为cn-north-1，Service为cv

主要用于鉴权，详见公共参数 - 签名参数 - 在Header中的场景部分

Body参数

注意

业务请求参数，放到request.body中，MIME-Type为application/json

参数	类型	可选/必选	说明
req_key	string	必选	服务标识取固定值: pippit_shortplay_cvtob_material_design
assets_id	string	必选	资产 ID，剧本解析接口返回的assets_id
thread_id	string	必选	会话 ID，剧本解析接口返回的thread_id
run_id	string	可选	用户自定义 ID，用于幂等校验当提交不同的 run_id 或不传入 run_id 时，会当做新任务处理并计费当重复提交相同 run_id 后，在查询任务时会响应错误码 50500 run_id 长度需小于32位

提交任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务返回参数

重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析)

字段	类型	说明
task_id	string	任务ID，用于查询结果

提交任务请求&返回完整示例

请求示例：

返回示例：

查询任务

查询任务请求参数

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31

参数	类型	可选/必选	说明
Action	string	必选	接口名，固定值：CVSync2AsyncGetResult
Version	string	必选	版本号，固定值：2022-08-31

Header参数

注意

本服务固定值：Region为cn-north-1，Service为cv

主要用于鉴权，详见公共参数 - 签名参数 - 在Header中的场景部分

Body参数

注意

业务请求参数，放到request.body中，MIME-Type为application/json

参数	类型	可选/必选	说明
req_key	string	必选	服务标识取固定值: pippit_shortplay_cvtob_material_design
task_id	string	必选	任务ID，此字段的取值为提交任务接口的返回

查询任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务返回参数

说明

重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析)

参数名	类型
status	string	任务执行状态 processing：任务前置处理 in_queue：任务已提交 generating：任务已被消费，处理中 done：处理完成，成功或者失败，可根据外层code&message进行判断 not_found：任务未找到，可能原因是无此任务或任务已过期(12小时) expired：任务已过期，请尝试重新提交任务请求
resp_data	JSON string	图片生成详细数据，格式为序列化后的JSON字符串，数据说明详见下表 RespData参数说明真实场景参数示例详见「小云雀-短剧漫剧Agent-全流程调用示例」

RespData参数说明

说明

可遍历 character_detail（角色资源详细内容）中的每一组 ExpectRenderImageCount（预期渲染图数量）和 ActualRenderImageCount（实际成功渲染图数量），当存在任意 ExpectRenderImageCount 不等于 ActualRenderImageCount 时表示有角色资源图片生成失败；

同上，可遍历 scene_detail（场景资源详细内容）中的每一组 ExpectRenderImageCount（预期渲染图数量）和 ActualRenderImageCount（实际成功渲染图数量），当存在任意 ExpectRenderImageCount 不等于 ActualRenderImageCount 时表示有场景资源图片生成失败；

生成失败的图片不支持重新生成或上传外部图片；

图片生成失败最常见原因为审核不通过，请检查剧本中是否有涉及敏感身份、职业角色或者不合规的人物特征设定；

层级	参数名称	类型	说明
1	assets_id	string	资产 ID
1	thread_id	string	会话 ID
1	status	string	状态说明
1	character_detail	array of object	角色资源详细内容
2	CharacterID	string	角色 ID
2	CharacterName	string	角色名称
2	Alias	array of string	角色别名
2	IsMainCharacter	bool	是否主角
2	IsMasses	bool	是否群众角色
2	Introduction	string	角色介绍
2	TagInfos	array of object	角色标签信息
3	Name	string	角色标签名称
3	Identity	array of string	角色标签标识
3	Personality	string	角色性格
3	Background	string	角色故事背景
3	Gender	string	角色性别
3	AgeGroup	string	角色年龄段
3	VoiceInfo	object	角色音色信息
4	Description	string	角色音色描述
3	AppearanceInfo	object	角色形象信息
4	Description	string	角色形象描述
3	IsCore	bool	是否核心角色
2	AppearanceTree	object	角色形象树，遍历可以得到对应人物所有人设图
3	NodeID	string	当前节点 ID
3	AssetID	string	节点对应的资产 ID
3	Detail	object	当前节点的形象详情
4	NodeID	string	节点 ID
4	Name	string	角色名称
4	StageName	string	所属阶段名称
4	Label	string	角色特征标签
4	FullName	string	完整名称
4	IsRoot	bool	是否根节点
4	Appearance	string	角色外貌描述
4	VoiceInfo	object	角色音色
5	Description	string	角色音色描述
4	BodyImageID	string	全身图 ID
4	BustPortraitID	string	半身图 ID
4	BodyImageURL	string	全身图 URL
4	BustPortraitURL	string	半身图 URL
3	Children	array of object	子节点列表，结构同外层AppearanceTree
4	NodeID	string	当前节点 ID
4	AssetID	string	节点对应的资产 ID
4	Detail	object	当前节点的形象详情
5	NodeID	string	节点 ID
5	Name	string	角色名称
5	StageName	string	所属阶段名称
5	Label	string	角色特征标签
5	FullName	string	完整名称
5	Appearance	string	角色形象描述
5	VoiceInfo	object	角色音色信息
6	Description	string	角色音色描述
5	Modify	string	相对父节点的调整描述
5	BodyImageID	string	全身图 ID
5	RelatedEpisodeNum	array of string	相关剧集
5	BodyImageURL	string	全身图 URL
2	ExpectRenderImageCount	int	预期渲染角色图数量
2	ActualRenderImageCount	int	实际成功渲染角色图数量
1	scene_detail	array of object	场景资源详细内容
2	SceneID	string	场景 ID
2	Name	string	场景名称
2	AppearanceDetails	array of object	场景视角资产列表
3	AppearanceID	string	场景表现形式 ID
3	Description	string	场景描述
3	ImageURL	string	场景渲染图片 URL
3	AssetID	string	场景图片资产 ID
3	Episodes	array of string	对应集数列表
3	AppearanceName	string	表现形式名称
2	ExpectRenderImageCount	int	预期渲染场景图数量
2	ActualRenderImageCount	int	实际成功渲染场景图数量
1	image_count	int	计费统计

查询任务请求&返回完整示例

真实场景参数示例详见「小云雀-短剧漫剧Agent-全流程调用示例」

请求示例：

返回示例：

返回报错示例：

错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

HttpCode	错误码	错误消息	描述	是否需要重试
200	10000	无	请求成功	不需要
400	50411	Pre Img Risk Not Pass	输入图片前审核未通过	不需要
400	50511	Post Img Risk Not Pass	输出图片后审核未通过	可重试
400	50412	Text Risk Not Pass	输入文本前审核未通过	不需要
400	50512	Post Text Risk Not Pass	输出文本后审核未通过	不需要
400	50513	Pre Video Risk Not Pass	输入视频前审核未通过	不需要
400	50514	Pre Audio Risk Not Pass	输入音频前审核未通过	不需要
400	50413	Post Text Risk Not Pass	输入文本含敏感词、版权词等审核不通过	不需要
429	50429	Request Has Reached API Limit, Please Try Later	QPS超限	可重试
429	50430	Request Has Reached API Concurrent Limit, Please Try Later	并发超限	可重试
500	50500	Internal Error	内部错误	可重试
500	50501	Internal RPC Error	内部算法错误	可重试

接入说明

SDK使用说明

请参考SDK使用说明

HTTP方式接入说明

请参考HTTP请求示例

最近更新时间：2026.05.19 14:14:42

这个页面对您有帮助吗？

有用

无用