创建任务
POST /tencent-vod/v1/aigc-video
说明
概览
| Method | POST |
|---|---|
| Path | /tencent-vod/v1/aigc-video |
| Type | http |
| Status | 1 |
| Module | 2102810 |
| Folder | 75127538 |
参数
{ "query": [], "path": [], "cookie": [], "header": [ { "required": false, "description": "", "type": "string", "id": "Jsj23RwEo1", "enable": true, "name": "Authorization", "sampleValue": "Bearer {{YOUR_API_KEY}}" }, { "required": false, "description": "", "type": "string", "id": "jjYSOg2NrR", "enable": true, "name": "Content-Type", "sampleValue": "application/json" } ] }
请求体
{ "type": "application/json", "parameters": [], "jsonSchema": { "type": "object", "properties": { "prompt": { "type": "string", "description": "提示词" }, "negative_prompt": { "type": "string", "description": "要阻止模型生成视频的提示词。\n示例值:red" }, "enhance_prompt": { "type": "string", "description": "是否自动优化提示词。开启时将自动优化传入的 Prompt,以提升生成质量。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n示例值:Enabled" }, "output_config": { "type": "object", "properties": { "storage_mode": { "type": "string", "description": "存储模式。取值有:\nPermanent:永久存储,生成的图片文件将存储到云点播,可在事件通知中获取到 FileId;\nTemporary:临时存储,生成的图片文件不会存储到云点播,可在事件通知中获取到临时访问的 URL;\n\n默认值:Temporary" }, "aspect_ratio": { "type": "string", "description": "指定所生成视频的宽高比。\n当 ModelName 是 Kling,当文生视频时,则可选值为 16:9、9:16、 1:1,默认为16:9;\n当 ModelName 是 Vidu,当文生视频时和使用参考图片生成时,则可选值为 16:9、9:16、4:3、3:4、1:1,其中仅版本q2支持4:3、3:4\n当 ModelName 是 Hailuo,则暂不支持。\n\n示例值:16:9" }, "person_generation": { "type": "string", "description": "是否允许人物或人脸生成。取值有:\nAllowAdult:允许生成成人;\nDisallowed:禁止在图片中包含人物或人脸;\n\n示例值:AllowAdult" }, "input_compliance_check": { "type": "string", "description": "是否开启输入内容的合规性检查。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n示例值:Enabled" }, "output_compliance_check": { "type": "string", "description": "是否开启输出内容的合规性检查。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n示例值:Enabled" }, "audio_generation": { "type": "string", "description": "是否生成音频。支持的模型包括 GV、OS。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n默认值:Disabled\n示例值:Enabled" }, "duration": { "type": "string", "description": "生成视频的时长,单位:秒。\n当 ModelName 是 Kling,可选值为 5、10,默认为 5;\n当 ModelName 是 Kling 并且 ModelVersion为3.0或3.0-Omni,可选值为3-15,默认5\n当 ModelName 是 Kling 并且 ModelVersion为3.0-Omni传入的文件分类为Video,可选值为3-10,默认5\n当 ModelName 是 Hailuo,可选值为 6、10,默认为 6;\n当 ModelName 是 Vidu,可指定1-10;\n\n示例值:8.0" }, "resolution": { "type": "string", "description": "生成视频的分辨率。\n当 ModelName 是 Kling,可选值为 720P、1080P,默认为 720P;\n当 ModelName 是 Hailuo,可选值为 768P、1080P,默认为 768P;\n当 ModelName 是 Vidu,可选值为 720P、1080P,默认为 720P;\n\n示例值:720P" } }, "x-apifox-orders": [ "storage_mode", "resolution", "aspect_ratio", "audio_generation", "duration", "person_generation", "input_compliance_check", "output_compliance_check" ], "description": "生视频任务的输出媒体文件配置。" }, "session_id": { "type": "string", "description": "用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。\n示例值:mysession" }, "session_context": { "type": "string", "description": "来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。\n示例值:mySessionContext" }, "tasks_priority": { "type": "string", "description": "任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。\n示例值:10" }, "ext_info": { "type": "object", "properties": { "AdditionalParameters": { "type": "object", "properties": { "multi_shot": { "type": "boolean", "description": "是否生成多镜头视频\n●当前参数为true时,prompt参数无效\n●当前参数为false时,shot_type参数及multi_prompt参数无效\n\n可用模型:\nKling的3.0和3.0-Omni\n\n注意:Kling的3.0-Omni视频参考不支持多镜头模式" }, "shot_type": { "type": "string", "description": "分镜方式\n●枚举值:customize\n当multi_shot参数为true时,当前参数必填\n\n可用模型:\nKling的3.0和3.0-Omni" }, "multi_prompt": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "description": "分镜序号:\n○最多支持6个分镜,最小支持1个分镜\n○每个分镜相关内容的最大长度不超过512\n" }, "prompt": { "type": "string", "description": "分镜提示词:\n当使用这个时,外层的总提示词参数传入的内容无效" }, "duration": { "type": "integer", "description": "分镜时长:\n○每个分镜的时长不大于当前任务的总时长,不小于1\n○所有分镜的时长之和等于当前任务的总时长\n" } }, "x-apifox-orders": [ "index", "prompt", "duration" ] }, "description": "各分镜信息,如提示词、时长等\n●通过index、prompt、duration参数定义分镜序号及相应提示词和时长,其中:\n○最多支持6个分镜,最小支持1个分镜\n○每个分镜相关内容的最大长度不超过512\n○每个分镜的时长不大于当前任务的总时长,不小于1\n○所有分镜的时长之和等于当前任务的总时长\n用key:value承载,\n\n可用模型:\nKling的3.0和3.0-Omni" } }, "x-apifox-orders": [ "multi_shot", "shot_type", "multi_prompt" ] } }, "x-apifox-orders": [ "AdditionalParameters" ], "description": "保留字段,特殊用途时使用。\n示例值:myextinfo" }, "file_infos": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "输入的视频文件类型。取值有:\nFile:点播媒体文件;\nUrl:可访问的 URL;\n\n示例值:File" }, "file_id": { "type": "string", "description": "图片文件的媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。当 Type 取值为 File 时,本参数有效。\n说明:\n1. 推荐使用小于7M的图片;\n2. 图片格式的取值为:jpeg,jpg, png, webp。\n示例值:3704211***509819" }, "text": { "type": "string", "description": "输入图片的描述信息,用于帮助模型理解图片。仅GEM 2.5、GEM 3.0 有效。\n示例值:任务背景:这是需要翻新的主建筑(图1),不得改变其几何结构。" }, "url": { "type": "string", "description": "可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。\n说明:\n1. 推荐使用小于7M的图片;\n2. 图片格式的取值为:jpeg,jpg, png, webp。\n示例值:https://test.com/1.png" }, "category": { "type": "string", "description": "文件分类。取值为:\nImage: 图片;\nVideo: 视频。\n示例值:Image" } }, "x-apifox-orders": [ "type", "category", "file_id", "url", "text" ] }, "description": "最多包含三张素材资源图片的列表,用于描述模型在生成视频时要使用的资源图片。\n\n支持多图输入的模型:\n1. GV,使用多图输入时,不可使用LastFrameFileId和LastFrameUrl。\n2. Vidu,支持多图参考生视频。q2模型1-7张图片,可通过FileInfos里面的ObjectId作为主体id来传入。\n\n注意:\n1. 图片大小不超过10M。\n2. 支持的图片格式:jpeg、png。" }, "last_frame_url": { "type": "string", "description": "用于作为尾帧画面来生成视频的媒体文件 URL。说明:\n1. 只支持模型 GV 、Kling、Vidu,其他模型暂不支持。当 ModelName 为 GV 时,如果指定该参数,则需同时指定 FileInfos 作为待生成视频的首帧。当 ModelName 为 Kling 、ModelVersion 为 2.1 并且指定输出分辨率 Resolution 为 1080P 时,才能指定该参数。当 ModelName 为 Vidu、ModelVersion 为 q2-pro、q2-turbo 时,才能指定该参数。\n2. 图片大小需小于5M。\n3. 3. 图片格式的取值为:jpeg,jpg, png, webp。\n示例值:https://test.com/1.png" }, "model_name": { "type": "string", "description": "模型名称。取值:\nHailuo:海螺;\nKling:可灵;\nVidu;\n\n示例值:GV" }, "model_version": { "type": "string", "description": "模型版本。取值:\n当 ModelName 是 Hailuo,可选值为 02、2.3、2.3-fast;\n当 ModelName 是 Kling,可选值为 1.6、2.0、2.1、2.5、O1、3.0、3.0-Omni;\n当 ModelName 是 Vidu,可选值为 q2、q2-pro、q2-turbo 、q3-pro、q3-turbo;\n示例值:2.3" }, "scene_type": { "type": "string", "description": "场景类型。取值如下:\n当 ModelName 为 Kling 时:\nmotion_control 表示动作控制;\navatar_i2v 表示数字人;\nlip_sync 表示对口型;\n其他 ModelName 暂不支持。\n\n示例值:motion_control" } }, "required": [ "model_name", "prompt", "model_version" ], "x-apifox-orders": [ "model_name", "model_version", "prompt", "negative_prompt", "enhance_prompt", "file_infos", "last_frame_url", "output_config", "scene_type", "session_id", "session_context", "tasks_priority", "ext_info" ] }, "required": false, "mediaType": "", "examples": [ { "mediaType": "application/json", "value": "{\r\n \"model_name\": \"Kling\",\r\n \"model_version\": \"1.6\",\r\n \"prompt\": \"一辆汽车在公路上行驶,阳光明媚\",\r\n \"negative_prompt\": \"模糊、抖动\",\r\n \"enhance_prompt\": \"Enabled\",\r\n \"output_config\": {\r\n \"storage_mode\": \"Temporary\",\r\n \"media_name\": \"car-video\",\r\n \"duration\": 8,\r\n \"resolution\": \"1080P\",\r\n \"aspect_ratio\": \"16:9\",\r\n \"audio_generation\": \"Enabled\",\r\n \"person_generation\": \"AllowAdult\",\r\n \"input_compliance_check\": \"Enabled\",\r\n \"output_compliance_check\": \"Enabled\",\r\n \"enhance_switch\": \"Enabled\"\r\n }\r\n}" } ], "oasExtensions": "" }
响应
[ { "id": 755089939, "name": "成功", "code": 200, "contentType": "json", "jsonSchema": { "type": "object", "properties": {}, "x-apifox-orders": [] }, "itemSchema": {}, "description": "", "mediaType": "", "headers": [], "oasExtensions": "" } ]
响应示例
[ { "name": "成功示例", "responseId": 755089939, "data": "{\r\n \"Response\": {\r\n \"TaskId\": \"251007502-AigcImage***2782aff1e896673f1ft\",\r\n \"RequestId\": \"f50d7667-72d8-46bb-a7e3-0613588971b6\"\r\n }\r\n}", "description": "", "oasKey": "", "oasExtensions": "", "id": 671652211 } ]