> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a Kling multimodal edit task
> Create a Kling multimodal video editing task via CometAPI: POST /kling/v1/videos/multi-elements to combine multiple elements and generate videos asynchronously.
Use this endpoint to submit the final multimodal video-editing job after your session and selections are ready.
## Full workflow
Start with [Initialize Video for Editing](./initialize-video-for-editing) to obtain the `session_id` for the clip you want to edit.
Use [Add Video Selection](./add-video-selection) and, when needed, [Preview Selected Video Area](./preview-selected-video-area) to refine the edit region.
Send the `session_id`, `edit_mode`, final `prompt`, and any optional generation settings through this endpoint, then save the returned task id for status checks.
## Before you call it
* Make sure the selection session is already initialized
* Confirm your region selection is correct before spending a generation call
* Run selection follow-up calls on the same account and with the exact `session_id` returned by initialization
* Set `edit_mode` to `addition`, `swap`, or `removal`
* Provide `image_list` for `addition` and `swap`; omit `image_list` for `removal`
* Send `duration` as a string such as `"5"` or `"10"`; examples pass `"5"` explicitly
* Treat this route as the final generation step, not the setup step
* Add `image_list`, `negative_prompt`, `mode`, `duration`, `callback_url`, or `external_task_id` only when the edit workflow needs them
For the complete parameter reference, see the [Kling API documentation](https://kling.ai/document-api/apiReference/model/multiElements).
## OpenAPI
````yaml api/openapi/video/kling/multimodal-video-editing/post-create-task.openapi.json POST /kling/v1/videos/multi-elements
openapi: 3.1.0
info:
title: Create Task API
version: 1.0.0
description: >-
Submit the final Kling multimodal video-editing job after the selection
session is ready.
servers:
- url: https://api.cometapi.com
security:
- bearerAuth: []
paths:
/kling/v1/videos/multi-elements:
post:
summary: Create a Kling multimodal edit task
description: >-
Send the `session_id`, `edit_mode`, and final edit prompt after the
selection area has already been prepared.
operationId: create_task
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- session_id
- edit_mode
- prompt
allOf:
- if:
properties:
edit_mode:
const: addition
required:
- edit_mode
then:
required:
- image_list
- if:
properties:
edit_mode:
const: swap
required:
- edit_mode
then:
required:
- image_list
properties:
session_id:
type: string
description: >-
Selection session id returned by init-selection. Follow-up
calls must use the same account and exact session id.
edit_mode:
type: string
description: >-
Editing operation for the selected video region. Use
`addition` to add an element, `swap` to replace a selected
element, or `removal` to remove it.
enum:
- addition
- swap
- removal
prompt:
type: string
description: >-
Instruction describing the desired edit. Reference the
source video as `<<>>` and any reference image as
`<<>>`.
model_name:
type: string
description: >-
Kling model variant for the final edit task. Omit to use
`kling-v1-6`.
enum:
- kling-v1-6
default: kling-v1-6
image_list:
type: array
description: >-
Image references used by `addition` and `swap` tasks. Omit
this field for `removal` tasks.
minItems: 1
items:
type: object
required:
- image
properties:
image:
type: string
negative_prompt:
type: string
description: Elements to avoid in the edited result.
mode:
type: string
description: Generation mode. Use `std` or `pro`.
enum:
- std
- pro
duration:
type: string
description: Requested output duration in seconds.
callback_url:
type: string
description: Webhook URL to receive task status updates.
external_task_id:
type: string
description: >-
Custom task id for your own tracking. Must be unique per
account.
default:
session_id:
edit_mode: removal
prompt: Delete the selected object from <<>>
mode: std
duration: '5'
examples:
Default:
summary: Multi-elements edit task
value:
session_id:
edit_mode: removal
prompt: Delete the selected object from <<>>
mode: std
duration: '5'
Addition:
summary: Add an image element to the selected area
value:
session_id:
edit_mode: addition
image_list:
- image: https://your-image-host/object-to-add.jpg
prompt: >-
Add <<>> naturally into <<>> at the
selected area
mode: std
duration: '5'
Swap:
summary: Swap the selected element with an image reference
value:
session_id:
edit_mode: swap
image_list:
- image: https://your-image-host/new-object.jpg
prompt: >-
Use <<>> to replace the selected object in
<<>>
mode: std
duration: '5'
responses:
'200':
description: Task accepted.
content:
application/json:
schema:
type: object
required:
- code
- message
- data
properties:
code:
type: integer
message:
type: string
data:
type: object
properties:
task_id:
type: string
task_status:
type: string
created_at:
type: integer
updated_at:
type: integer
additionalProperties: true
x-codeSamples:
- lang: Shell
label: Default
source: |
curl https://api.cometapi.com/kling/v1/videos/multi-elements \
-H "Authorization: Bearer $COMETAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"session_id": "",
"edit_mode": "removal",
"prompt": "Delete the selected object from <<>>",
"mode": "std",
"duration": "5"
}'
- lang: Python
label: Default
source: |
import os
import requests
response = requests.post(
"https://api.cometapi.com/kling/v1/videos/multi-elements",
headers={"Authorization": "Bearer " + os.environ["COMETAPI_KEY"]},
json={
"session_id": "",
"edit_mode": "removal",
"prompt": "Delete the selected object from <<>>",
"mode": "std",
"duration": "5"
},
)
result = response.json()
print(result.get("code"), result.get("data", {}).get("task_id"))
- lang: JavaScript
label: Default
source: >
const response = await
fetch("https://api.cometapi.com/kling/v1/videos/multi-elements", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.COMETAPI_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"session_id": "",
"edit_mode": "removal",
"prompt": "Delete the selected object from <<>>",
"mode": "std",
"duration": "5"
}),
});
const result = await response.json();
console.log(result.code, result.data?.task_id);
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Bearer token authentication. Use your CometAPI key.
````