{
"contentType": "application/json",
"properties": {
"enhance_prompt": {
"description": "是否自动优化提示词。开启时将自动优化传入的 Prompt,以提升生成质量。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n示例值:Enabled",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Whether to automatically optimize prompt words. When turned on, incoming prompts will be automatically optimized to improve build quality. The values are:\nEnabled: turned on;\nDisabled: closed;\n\nExample value: Enabled"
}
}
},
"ext_info": {
"description": "保留字段,特殊用途时使用。\n示例值:myextinfo",
"properties": {
"AdditionalParameters": {
"properties": {
"multi_prompt": {
"description": "各分镜信息,如提示词、时长等\n●通过index、prompt、duration参数定义分镜序号及相应提示词和时长,其中:\n○最多支持6个分镜,最小支持1个分镜\n○每个分镜相关内容的最大长度不超过512\n○每个分镜的时长不大于当前任务的总时长,不小于1\n○所有分镜的时长之和等于当前任务的总时长\n用key:value承载,\n\n可用模型:\nKling的3.0和3.0-Omni",
"items": {
"properties": {
"duration": {
"description": "分镜时长:\n○每个分镜的时长不大于当前任务的总时长,不小于1\n○所有分镜的时长之和等于当前任务的总时长\n",
"type": "integer",
"x-i18n": {
"en-US": {
"description": "Storyboard duration:\n○The duration of each storyboard shall not be greater than the total duration of the current task and shall not be less than 1\n○The sum of the duration of all storyboards is equal to the total duration of the current task"
}
}
},
"index": {
"description": "分镜序号:\n○最多支持6个分镜,最小支持1个分镜\n○每个分镜相关内容的最大长度不超过512\n",
"type": "integer",
"x-i18n": {
"en-US": {
"description": "Storyboard serial number:\n○Supports up to 6 storyboards and a minimum of 1 storyboard\n○The maximum length of each storyboard-related content does not exceed 512"
}
}
},
"prompt": {
"description": "分镜提示词:\n当使用这个时,外层的总提示词参数传入的内容无效",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Storyboard prompts:\nWhen using this, the content passed in the outer total prompt word parameter is invalid."
}
}
}
},
"type": "object"
},
"type": "array",
"x-i18n": {
"en-US": {
"description": "Each storyboard information, such as prompt words, duration, etc.\n●Define the storyboard sequence number and corresponding prompt words and duration through the index, prompt, and duration parameters, among which:\n○Supports up to 6 storyboards and a minimum of 1 storyboard\n○The maximum length of each storyboard-related content does not exceed 512\n○The duration of each storyboard shall not be greater than the total duration of the current task and shall not be less than 1\n○The sum of the duration of all storyboards is equal to the total duration of the current task\nUse key:value to carry,\n\nAvailable models:\nKling's 3.0 and 3.0-Omni"
}
}
},
"multi_shot": {
"description": "是否生成多镜头视频\n●当前参数为true时,prompt参数无效\n●当前参数为false时,shot_type参数及multi_prompt参数无效\n\n可用模型:\nKling的3.0和3.0-Omni\n\n注意:Kling的3.0-Omni视频参考不支持多镜头模式",
"type": "boolean",
"x-i18n": {
"en-US": {
"description": "Whether to generate multi-lens video\n●When the current parameter is true, the prompt parameter is invalid\n●When the current parameter is false, the shot_type parameter and multi_prompt parameter are invalid.\n\nAvailable models:\nKling's 3.0 and 3.0-Omni\n\nNote: Kling's 3.0-Omni video reference does not support multi-camera mode"
}
}
},
"shot_type": {
"description": "分镜方式\n●枚举值:customize\n当multi_shot参数为true时,当前参数必填\n\n可用模型:\nKling的3.0和3.0-Omni",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Storyboarding method\n●Enumeration value: customize\nWhen the multi_shot parameter is true, the current parameter is required\n\nAvailable models:\nKling's 3.0 and 3.0-Omni"
}
}
}
},
"type": "object"
}
},
"type": "object",
"x-i18n": {
"en-US": {
"description": "Reserved fields, used for special purposes.\nExample value: myextinfo"
}
}
},
"file_infos": {
"description": "最多包含三张素材资源图片的列表,用于描述模型在生成视频时要使用的资源图片。\n\n支持多图输入的模型:\n1. GV,使用多图输入时,不可使用LastFrameFileId和LastFrameUrl。\n2. Vidu,支持多图参考生视频。q2模型1-7张图片,可通过FileInfos里面的ObjectId作为主体id来传入。\n\n注意:\n1. 图片大小不超过10M。\n2. 支持的图片格式:jpeg、png。",
"items": {
"properties": {
"category": {
"description": "文件分类。取值为:\nImage: 图片;\nVideo: 视频。\n示例值:Image",
"type": "string",
"x-i18n": {
"en-US": {
"description": "File classification. The values are:\nImage: picture;\nVideo: video.\nExample value: Image"
}
}
},
"file_id": {
"description": "图片文件的媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。当 Type 取值为 File 时,本参数有效。\n说明:\n1. 推荐使用小于7M的图片;\n2. 图片格式的取值为:jpeg,jpg, png, webp。\n示例值:3704211***509819",
"type": "string",
"x-i18n": {
"en-US": {
"description": "The media file ID of the image file, which is the globally unique identifier of the file on the cloud on demand, is assigned by the cloud on demand background after the upload is successful. This field can be obtained in the video upload completion event notification or cloud on-demand console. This parameter is valid when the value of Type is File.\nDescription:\n1. It is recommended to use pictures smaller than 7M;\n2. The value of the image format is: jpeg, jpg, png, webp.\nExample value: 3704211***509819"
}
}
},
"text": {
"description": "输入图片的描述信息,用于帮助模型理解图片。仅GEM 2.5、GEM 3.0 有效。\n示例值:任务背景:这是需要翻新的主建筑(图1),不得改变其几何结构。",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Enter the description information of the image to help the model understand the image. Only valid for GEM 2.5 and GEM 3.0.\nExample values: Task context: This is the main building that needs renovation (Fig. 1), its geometry must not be changed."
}
}
},
"type": {
"description": "输入的视频文件类型。取值有:\nFile:点播媒体文件;\nUrl:可访问的 URL;\n\n示例值:File",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Input video file type. The values are:\nFile: on-demand media files;\nUrl: accessible URL;\n\nExample value: File"
}
}
},
"url": {
"description": "可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。\n说明:\n1. 推荐使用小于7M的图片;\n2. 图片格式的取值为:jpeg,jpg, png, webp。\n示例值:https://test.com/1.png",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Accessible file URL. This parameter is valid when the value of Type is Url.\nDescription:\n1. It is recommended to use pictures smaller than 7M;\n2. The value of the image format is: jpeg, jpg, png, webp.\nExample value: https://test.com/1.png"
}
}
}
},
"type": "object"
},
"type": "array",
"x-i18n": {
"en-US": {
"description": "A list of up to three asset images describing the asset images to be used by the model when generating the video.\n\nModels that support multi-image input:\n1. GV, when using multi-image input, LastFrameFileId and LastFrameUrl cannot be used.\n2. Vidu supports multi-image reference videos. Pictures 1-7 of the q2 model can be passed in through the ObjectId in FileInfos as the subject id.\n\nNote:\n1. The image size should not exceed 10M.\n2. Supported image formats: jpeg, png."
}
}
},
"last_frame_url": {
"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",
"type": "string",
"x-i18n": {
"en-US": {
"description": "The media file URL used to generate the video as the end frame. Description:\n1. Only models GV, Kling, and Vidu are supported. Other models are not supported yet. When ModelName is GV, if this parameter is specified, FileInfos must also be specified as the first frame of the video to be generated. This parameter can only be specified when the ModelName is Kling, the ModelVersion is 2.1 and the specified output resolution is 1080P. This parameter can be specified only when ModelName is Vidu and ModelVersion is q2-pro or q2-turbo.\n2. The image size must be less than 5M.\n3. 3. The value of the image format is: jpeg, jpg, png, webp.\nExample value: https://test.com/1.png"
}
}
},
"model_name": {
"description": "模型名称。取值:\nHailuo:海螺;\nKling:可灵;\nVidu;\n\n示例值:GV",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Model name. Value:\nHailuo: conch;\nKling: Keling;\nVidu;\n\nExample value: GV"
}
}
},
"model_version": {
"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",
"type": "string",
"x-i18n": {
"en-US": {
"description": "model version. Value:\nWhen ModelName is Hailuo, the optional values are 02, 2.3, 2.3-fast;\nWhen ModelName is Kling, the optional values are 1.6, 2.0, 2.1, 2.5, O1, 3.0, 3.0-Omni;\nWhen ModelName is Vidu, the optional values are q2, q2-pro, q2-turbo, q3-pro, q3-turbo;\nExample value: 2.3"
}
}
},
"negative_prompt": {
"description": "要阻止模型生成视频的提示词。\n示例值:red",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Prompt word to prevent the model from generating videos.\nExample value: red"
}
}
},
"output_config": {
"description": "生视频任务的输出媒体文件配置。",
"properties": {
"aspect_ratio": {
"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",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Specifies the aspect ratio of the generated video.\nWhen ModelName is Kling and Vincent video is used, the optional values are 16:9, 9:16, 1:1, and the default is 16:9;\nWhen ModelName is Vidu, when generating videos and using reference images, the optional values are 16:9, 9:16, 4:3, 3:4, and 1:1. Only version q2 supports 4:3 and 3:4.\nWhen ModelName is Hailuo, it is not supported yet.\n\nExample value: 16:9"
}
}
},
"audio_generation": {
"description": "是否生成音频。支持的模型包括 GV、OS。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n默认值:Disabled\n示例值:Enabled",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Whether to generate audio. Supported models include GV, OS. The values are:\nEnabled: turned on;\nDisabled: closed;\n\nDefault value: Disabled\nExample value: Enabled"
}
}
},
"duration": {
"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",
"type": "string",
"x-i18n": {
"en-US": {
"description": "The duration of the generated video, unit: seconds.\nWhen ModelName is Kling, the optional values are 5 and 10, and the default is 5;\nWhen ModelName is Kling and ModelVersion is 3.0 or 3.0-Omni, optional values are 3-15, default 5\nWhen ModelName is Kling and ModelVersion is 3.0 - the file passed in by Omni is classified as Video, the optional value is 3-10, the default is 5\nWhen ModelName is Hailuo, the optional values are 6 and 10, and the default is 6;\nWhen ModelName is Vidu, 1-10 can be specified;\n\nExample value: 8.0"
}
}
},
"input_compliance_check": {
"description": "是否开启输入内容的合规性检查。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n示例值:Enabled",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Whether to enable compliance checking of input content. The values are:\nEnabled: turned on;\nDisabled: closed;\n\nExample value: Enabled"
}
}
},
"output_compliance_check": {
"description": "是否开启输出内容的合规性检查。取值有:\nEnabled:开启;\nDisabled:关闭;\n\n示例值:Enabled",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Whether to enable compliance checking of output content. The values are:\nEnabled: turned on;\nDisabled: closed;\n\nExample value: Enabled"
}
}
},
"person_generation": {
"description": "是否允许人物或人脸生成。取值有:\nAllowAdult:允许生成成人;\nDisallowed:禁止在图片中包含人物或人脸;\n\n示例值:AllowAdult",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Whether to allow character or face generation. The values are:\nAllowAdult: Allows adults to be generated;\nDisallowed: It is prohibited to include people or faces in images;\n\nExample value: AllowAdult"
}
}
},
"resolution": {
"description": "生成视频的分辨率。\n当 ModelName 是 Kling,可选值为 720P、1080P,默认为 720P;\n当 ModelName 是 Hailuo,可选值为 768P、1080P,默认为 768P;\n当 ModelName 是 Vidu,可选值为 720P、1080P,默认为 720P;\n\n示例值:720P",
"type": "string",
"x-i18n": {
"en-US": {
"description": "The resolution of the generated video.\nWhen ModelName is Kling, the optional values are 720P and 1080P, and the default is 720P;\nWhen ModelName is Hailuo, the optional values are 768P and 1080P, and the default is 768P;\nWhen ModelName is Vidu, the optional values are 720P and 1080P, and the default is 720P;\n\nExample value: 720P"
}
}
},
"storage_mode": {
"description": "存储模式。取值有:\nPermanent:永久存储,生成的图片文件将存储到云点播,可在事件通知中获取到 FileId;\nTemporary:临时存储,生成的图片文件不会存储到云点播,可在事件通知中获取到临时访问的 URL;\n\n默认值:Temporary",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Storage mode. The values are:\nPermanent: Permanent storage, the generated image files will be stored in the cloud on demand, and the FileId can be obtained in the event notification;\nTemporary: Temporary storage. The generated image files will not be stored in the cloud on demand. The URL for temporary access can be obtained in the event notification;\n\nDefault value: Temporary"
}
}
}
},
"type": "object",
"x-i18n": {
"en-US": {
"description": "Output media file configuration for video generation tasks."
}
}
},
"prompt": {
"description": "提示词",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Prompt"
}
}
},
"scene_type": {
"description": "场景类型。取值如下:\n当 ModelName 为 Kling 时:\nmotion_control 表示动作控制;\navatar_i2v 表示数字人;\nlip_sync 表示对口型;\n其他 ModelName 暂不支持。\n\n示例值:motion_control",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Scene type. The values are as follows:\nWhen ModelName is Kling:\nmotion_control represents motion control;\navatar_i2v represents digital person;\nlip_sync means lip sync;\nOther ModelNames are not supported yet.\n\nExample value: motion_control"
}
}
},
"session_context": {
"description": "来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。\n示例值:mySessionContext",
"type": "string",
"x-i18n": {
"en-US": {
"description": "Source context, used to transparently transmit user request information. The audio and video quality regeneration completion callback will return the value of this field, with a maximum length of 1000 characters.\nExample value: mySessionContext"
}
}
},
"session_id": {
"description": "用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。\n示例值:mysession",
"type": "string",
"x-i18n": {
"en-US": {
"description": "The identification code used for deduplication. If there is a request for the same identification code within three days, this request will return an error. The maximum length is 50 characters, without or with an empty string to indicate no deduplication.\nExample value: mysession"
}
}
},
"tasks_priority": {
"description": "任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。\n示例值:10",
"type": "string",
"x-i18n": {
"en-US": {
"description": "The priority of the task. The larger the value, the higher the priority. The value range is -10 to 10. If left blank, it means 0.\nExample value: 10"
}
}
}
},
"required": [
"model_name",
"prompt",
"model_version"
]
}