/** * DescribeImageToVideoGeneralJob返回参数结构体 */ export interface DescribeImageToVideoGeneralJobResponse { /** * 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功 */ Status?: string; /** * 任务执行错误码。当任务状态不为 FAIL 时,该值为""。 */ ErrorCode?: string; /** * 任务执行错误信息。当任务状态不为 FAIL 时,该值为""。 */ ErrorMessage?: string; /** * 结果视频 URL。有效期 24 小时。 */ ResultVideoUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitVideoStylizationJob请求参数结构体 */ export interface SubmitVideoStylizationJobRequest { /** * 风格ID。取值说明: 2d_anime:2D动漫; 3d_cartoon:3D卡通; 3d_china:3D国潮; pixel_art:像素风。 */ StyleId: string; /** * 输入视频URL。视频要求: - 视频格式:mp4、mov; - 视频时长:1~60秒; - 视频分辨率:540P~2056P,即长宽像素数均在540px~2056px范围内; - 视频大小:不超过200M; - 视频FPS:15~60fps。 */ VideoUrl: string; /** * 风格化强度。取值说明: low:风格化强度弱; medium:风格化强度中等; high:风格化强度强。 默认值为medium。 */ StyleStrength?: string; } /** * logo参数 */ export interface LogoParam { /** * 水印 Url */ LogoUrl?: string; /** * 水印 Base64,Url 和 Base64 二选一传入,如果都提供以 Url 为准 */ LogoImage?: string; /** * 水印图片位于生成结果图中的坐标及宽高,将按照坐标对标识图片进行位置和大小的拉伸匹配。 */ LogoRect?: LogoRect; } /** * DescribeVideoVoiceJob返回参数结构体 */ export interface DescribeVideoVoiceJobResponse { /** * 任务状态。 WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功 */ Status?: string; /** * 结果视频URL。有效期 24 小时。 */ ResultVideoUrl?: string; /** * 任务执行错误码。当任务状态不为 FAIL 时,该值为""。 */ ErrorCode?: string; /** * 任务执行错误信息。当任务状态不为 FAIL 时,该值为""。 */ ErrorMessage?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitHumanActorJob请求参数结构体 */ export interface SubmitHumanActorJobRequest { /** * 文本提示词,不能超过5000字符。 提示词支持全局和局部控制: - 全局控制:正常输入提示词即可 - 局部控制:可用双井号进行特定时间的提示词约束,例如: "画面中的人物正在对着镜头讲话,偶尔做些手势匹配说话的内容。镜头保持固定。#3#画面中的人物正在对着镜头讲话,同时做出单手做向左方引导的手势。镜头保持固定。"(意思是第三秒的时候让人物做出左方引导手势) -- 局部控制时间建议整数,最大可读小数点后两位。 */ Prompt: string; /** * 传入音频URL地址,音频要求: - 音频时长:2秒 - 60秒 - 音频格式:mp3、wav - 音频大小:10M以内 */ AudioUrl: string; /** * 传入图片URL地址,图片要求: - 图片格式:jpg、jpeg、png、bmp、webp - 图片分辨率:192~4096 - 图片大小:不超过10M - 图片宽高比:图片【宽:高】在1:4到4:1范围内 - 图片内容:避免上传无人脸、无宠物脸或脸部过小、不完整、不清晰、偏转角度过大、嘴部被遮挡的图片。 */ ImageUrl?: string; /** * 传入图片Base64编码,编码后请求体大小不超过10M。 图片Base64编码与URL地址必传其一,如果都传以ImageUrl为准。 */ ImageBase64?: string; /** * 生成视频分辨率 枚举值:720p,1080p 默认1080p */ Resolution?: string; /** * 生成视频帧数,单位fps。 枚举值:25,50 默认50帧 */ FrameRate?: number; /** * 为生成视频添加标识的开关,默认为1。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示,该视频是 AI 生成的视频。 */ LogoAdd?: number; /** * 标识内容设置。 默认在生成视频的右下角添加“视频由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 */ LogoParam?: LogoParam; } /** * SubmitImageAnimateJob返回参数结构体 */ export interface SubmitImageAnimateJobResponse { /** * 图片跳舞任务ID。 */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模板信息 */ export interface FaceTemplateInfo { /** * 角色ID。需要与MergeInfos中的TemplateFaceID依次对应。需要填数字,建议填"0"、"1",依次累加。 */ TemplateFaceID?: string; /** * 视频模板中要替换的人脸图片 */ TemplateFaceImage?: Image; /** * 视频模板中要替换的人脸图片的人脸框。不填默认取要替换的人脸图片中最大人脸。 */ TemplateFaceRect?: FaceRect; } /** * DescribeAigcVideoJob请求参数结构体 */ export interface DescribeAigcVideoJobRequest { /** * 任务ID。 示例值:1194931538865782784 */ JobId?: string; } /** * SubmitImageAnimateJob请求参数结构体 */ export interface SubmitImageAnimateJobRequest { /** * 图片格式:支持PNG、JPG、JPEG、BMP、WEBP格式; 图片分辨率:长边分辨率范围【192,4096】; 图片大小:不超过10M; 图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 */ ImageUrl?: string; /** * 图片base64数据。 图片格式:支持PNG、JPG、JPEG、BMP、WEBP格式; 图片分辨率:长边分辨率范围【192,4096】; 图片大小:不超过10M; 图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 */ ImageBase64?: string; /** * 动作模板ID。取值说明:ke3 科目三;tuziwu 兔子舞;huajiangwu 划桨舞。 */ TemplateId?: string; /** * 结果视频是否保留模板音频。默认为true */ EnableAudio?: boolean; /** * 是否对输入图采用加强检测方案。 默认不加强检测(false),仅对输入图做必要的基础检测。 开启加强检测(true)有助于提升效果稳定性,将根据选择的动作模板提取建议的人体关键点,并判断输入图中是否包含这些人体关键点。加强检测仅对人像输入图生效,对非人输入图不生效。 */ EnableBodyJoins?: boolean; /** * 是否对结果视频背景进行分割,默认值为false。 true:分割结果视频,结果视频(ResultVideoUrl)将为去除背景的绿幕视频,并返回掩码视频(MaskVideoUrl); false:不分割结果视频,结果视频(ResultVideoUrl)为带背景的视频,掩码视频(MaskVideoUrl)为空字符串。 */ EnableSegment?: boolean; /** * 为生成视频添加标识的开关,默认为0。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示,该视频是 AI 生成的视频。 */ LogoAdd?: number; /** * 标识内容设置。 默认在生成视频的右下角添加“视频由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 */ LogoParam?: LogoParam; /** * 是否开启人脸检测。 默认开启人脸检测(true),拦截主体为人像但无人脸、人脸不完整或被遮挡的输入图。可选关闭人脸检测(false)。 */ EnableFace?: boolean; } /** * DescribeVideoVoiceJob请求参数结构体 */ export interface DescribeVideoVoiceJobRequest { /** * 任务ID。 */ JobId?: string; } /** * SubmitImageToVideoGeneralJob返回参数结构体 */ export interface SubmitImageToVideoGeneralJobResponse { /** * 任务ID */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeVideoFaceFusionJob返回参数结构体 */ export interface DescribeVideoFaceFusionJobResponse { /** * 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功 */ Status?: string; /** * 任务执行错误码。当任务状态不为 FAIL 时,该值为""。 */ ErrorCode?: string; /** * 任务执行错误信息。当任务状态不为 FAIL 时,该值为""。 */ ErrorMessage?: string; /** * 结果视频 URL。有效期 24 小时。 */ ResultVideoUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeVideoFaceFusionJob请求参数结构体 */ export interface DescribeVideoFaceFusionJobRequest { /** * 任务ID */ JobId?: string; } /** * 人脸框信息。 */ export interface FaceRect { /** * 人脸框左上角横坐标。 */ X?: number; /** * 人脸框左上角纵坐标。 */ Y?: number; /** * 人脸框宽度。 */ Width?: number; /** * 人脸框高度。 */ Height?: number; } /** * DescribePortraitSingJob请求参数结构体 */ export interface DescribePortraitSingJobRequest { /** * 任务ID */ JobId: string; } /** * DescribeHunyuanToVideoJob请求参数结构体 */ export interface DescribeHunyuanToVideoJobRequest { /** * 任务ID */ JobId: string; } /** * SubmitVideoFaceFusionJob返回参数结构体 */ export interface SubmitVideoFaceFusionJobResponse { /** * 视频人脸融合任务的job id(job有效期24小时) */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTemplateToVideoJob返回参数结构体 */ export interface DescribeTemplateToVideoJobResponse { /** * 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功 */ Status?: string; /** * 任务执行错误码。当任务状态不为 FAIL 时,该值为""。 */ ErrorCode?: string; /** * 任务执行错误信息。当任务状态不为 FAIL 时,该值为""。 */ ErrorMessage?: string; /** * 结果视频 URL。有效期 24 小时。 */ ResultVideoUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitVideoVoiceJob返回参数结构体 */ export interface SubmitVideoVoiceJobResponse { /** * 任务ID。 */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 人脸图片和待被融合的素材模板图的人脸位置信息。 */ export interface FaceMergeInfo { /** * 融合图片 */ MergeFaceImage?: Image; /** * 上传的图片人脸位置信息(人脸框) Width、Height >= 30。 */ MergeFaceRect?: FaceRect; /** * 素材人脸ID,不填默认取上传图片中最大人脸。 */ TemplateFaceID?: string; } /** * CheckAnimateImageJob返回参数结构体 */ export interface CheckAnimateImageJobResponse { /** * 输入图是否通过校验。 */ CheckPass?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitVideoEditJob返回参数结构体 */ export interface SubmitVideoEditJobResponse { /** * 任务ID。 */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitTemplateToVideoJob返回参数结构体 */ export interface SubmitTemplateToVideoJobResponse { /** * 任务ID。 */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckAnimateImageJob请求参数结构体 */ export interface CheckAnimateImageJobRequest { /** * 动作模板ID。 */ TemplateId: string; /** * 图片格式:支持PNG、JPG、JPEG、BMP、WEBP格式; 图片分辨率:长边分辨率范围【192,4096】; 图片大小:不超过10M; 图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 */ ImageUrl?: string; /** * 图片base64数据。 图片格式:支持PNG、JPG、JPEG、BMP、WEBP格式; 图片分辨率:长边分辨率范围【192,4096】; 图片大小:不超过10M; 图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 */ ImageBase64?: string; /** * 是否对输入图采用加强检测方案。 默认不加强检测(false),仅对输入图做必要的基础检测。 开启加强检测(true)有助于提升效果稳定性,将根据选择的动作模板提取建议的人体关键点,并判断输入图中是否包含这些人体关键点。加强检测仅对人像输入图生效,对非人输入图不生效。 */ EnableBodyJoins?: boolean; /** * 是否开启人脸检测。 默认开启人脸检测(true),拦截主体为人像但无人脸、人脸不完整或被遮挡的输入图。可选关闭人脸检测(false)。 */ EnableFace?: boolean; } /** * DescribeVideoStylizationJob请求参数结构体 */ export interface DescribeVideoStylizationJobRequest { /** * 任务ID */ JobId: string; } /** * SubmitHumanActorJob返回参数结构体 */ export interface SubmitHumanActorJobResponse { /** * 任务ID。 */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeImageAnimateJob返回参数结构体 */ export interface DescribeImageAnimateJobResponse { /** * 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功 */ Status?: string; /** * 错误码。 */ ErrorCode?: string; /** * 错误信息。 */ ErrorMessage?: string; /** * 结果视频URL。有效期 24 小时。 */ ResultVideoUrl?: string; /** * 掩码视频链接 */ MaskVideoUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitPortraitSingJob请求参数结构体 */ export interface SubmitPortraitSingJobRequest { /** * 传入音频URL地址,音频要求: - 音频时长:2秒 - 60秒 - 音频格式:mp3、wav、m4a */ AudioUrl: string; /** * 传入图片URL地址,图片要求: - 图片格式:jpg、jpeg、png、bmp、webp - 图片分辨率:192~4096 - 图片大小:不超过10M - 图片宽高比:图片【宽:高】在1:2到2:1范围内 - 图片内容:避免上传无人脸、无宠物脸或脸部过小、不完整、不清晰、偏转角度过大、嘴部被遮挡的图片。 */ ImageUrl?: string; /** * 传入图片Base64编码,编码后请求体大小不超过10M。 图片Base64编码与URL地址必传其一,如果都传以ImageBase64为准。 */ ImageBase64?: string; /** * 唱演模式,默认使用人像模式。 Person:人像模式,仅支持上传人像图片,人像生成效果更好,如果图中未检测到有效人脸将被拦截,生成时会将视频短边分辨率放缩至512。 Pet:宠物模式,支持宠物等非人像图片,固定生成512:512分辨率视频。 */ Mode?: string; /** * 生成视频尺寸。可选取值:"512:512"。 人像模式下,如果不传该参数,默认生成视频的短边分辨率为512,长边分辨率不固定、由模型根据生成效果自动适配得到。如需固定生成分辨率可传入512:512。 宠物模式下,如果不传该参数,默认将脸部唱演视频回贴原图,生成视频分辨率与原图一致。如不需要脸部回贴,仅保留脸部唱演视频,可传入512:512。 */ Resolution?: string; /** * 为生成视频添加标识的开关,默认为1。 1:添加标识; 0:不添加标识; 其他数值:默认按1处理。 建议您使用显著标识来提示,该视频是 AI 生成的视频。 */ LogoAdd?: number; /** * 标识内容设置。 默认在生成视频的右下角添加“视频由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 */ LogoParam?: LogoParam; } /** * 水印图输入框 */ export interface LogoRect { /** * 水印图框X坐标值。当值大于0时,坐标轴原点位于原图左侧,方向指右;当值小于0时,坐标轴原点位于原图右侧,方向指左。 */ X?: number; /** * 水印图框Y坐标值。当值大于0时,坐标轴原点位于原图上侧,方向指下;当值小于0时,坐标轴原点位于原图下侧,方向指上。 */ Y?: number; /** * 水印图框宽度。 */ Width?: number; /** * 水印图框高度。 */ Height?: number; } /** * DescribeAigcVideoJob返回参数结构体 */ export interface DescribeAigcVideoJobResponse { /** * 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功 示例值:RUN */ Status?: string; /** * 任务执行错误码。当任务状态不为 FAIL 时,该值为""。 示例值:FailedOperation.DriverFailed */ ErrorCode?: string; /** * 任务执行错误信息。当任务状态不为 FAIL 时,该值为""。 示例值:驱动失败 */ ErrorMessage?: string; /** * 结果视频 URL。有效期 24 小时。 示例值:https://console.cloud.tencent.com/result.mp4 */ ResultUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitVideoVoiceJob请求参数结构体 */ export interface SubmitVideoVoiceJobRequest { /** * 输入视频的Url 上传视频时长限制:1-15s 视频格式:MP4,MOV 视频大小:不超过1 GB URL地址中不能包含中文字符。 */ VideoUrl?: string; /** * 描述音效内容的正向提示词。输入上限50个字符。 */ Prompt?: string; /** * 音效内容的原始负向提示词。输入上限50个字符。 */ NegativePrompt?: string; /** * 为生成视频添加标识的开关,默认为1。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示,该视频是 AI 生成的视频。 */ LogoAdd?: number; /** * 标识内容设置。 默认在生成视频的右下角添加“视频由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 */ LogoParam?: LogoParam; } /** * SubmitAigcVideoJob请求参数结构体 */ export interface SubmitAigcVideoJobRequest { /** *
模型名称。
枚举值:
● Vidu;
● Kling:可灵;
● HY:混元;
● YT:优图;
示例值:Vidu
*/ Vendor: string; /** *模型版本。
枚举值:
● 当Vendor为Vidu时,可选值[q2, q2-pro, q2-turbo, q3-pro, q3-turbo]
● 当Vendor为Kling时,可选值[v1.6, v2.0, v2.1, v2.5, v2.6]
● 当Vendor为HY时,默认值:[v1.5]
● 当Vendor为YT时,默认值:[v2.0]
*/ Model: string; /** *模型参数Json-Format字符串
模型参数列表
正向文本提示词。不能超过2000个字符
示例值:一只小猫在草地奔跑
*/ Prompt?: string; /** *为生成结果图添加显式水印标识的开关,默认为1。
1:添加。
0:不添加。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
示例值:1
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
任务ID。
*/ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTemplateToVideoJob请求参数结构体 */ export interface DescribeTemplateToVideoJobRequest { /** * 任务ID。 */ JobId: string; } /** * SubmitVideoEditJob请求参数结构体 */ export interface SubmitVideoEditJobRequest { /** * 参考视频URL。默认为待编辑视频。 - 视频格式:支持MP4 - 视频时长:输入视频时长≤5秒 - 视频大小:不超过200M - 视频文件:输入的视频帧率及分辨率不做限制(建议输入16:9或9:16的视频;分辨率建议在2160px内,帧率建议在60fps内);输出视频是帧率会≥16fps,分辨率为720p */ VideoUrl: string; /** * 视频内容的描述,中文正向提示词。支持视频内容增加、删除、修改等能力 - 最多支持200个 utf-8 字符(首尾空格不计入字符数) - 不传prompt的时候,Images.N参考图列表必须要传图,且传的图片是经过图片编辑之后的结果图 */ Prompt?: string; /** * 参考图列表。用于对视频内容做风格迁移、内容替换、内容删减、内容增加做参考。 - 支持传入图片Base64编码或图片URL - 图片格式:支持jpg,png,jpeg,webp,bmp,tiff 格式 - 图片文件:大小不能超过10MB(base64后)。单边分辨率不超过5000px,不小于50px,图片长宽限制1:4 ~ 4:1。 示例值:[{ "Url": "https://console.cloud.tencent.com/cos/image.png"}] */ Images?: Array