v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

Submit Task

Submit an asynchronous video object-remove task. Returns a taskId for polling via the query API. Credits are charged after completion based on video duration. Use costCredit in the query response to check consumption.

post/v1/common-task/video-object-remove/submit

Headers

Topview-Uidstring required

User ID

Authorizationstring required

API Key for authentication

Request body

mode'auto' | 'clear-inside' | 'clear-outside' required

Removal mode. auto: full-frame auto removal, selectionBox may be omitted. clear-inside: remove the content inside the selection box. clear-outside: remove content outside the selection box (i.e. keep inside).

videoFileIdstring required

Video fileId returned from the upload API (required). Must be of type video and use a supported video format.

noticeUrlstring

Optional webhook URL invoked when the task completes. See official callback documentation.Reference Doc

boardIdstring

Optional associated Board ID

Response

Task submitted successfully

codestring

Response status code

messagestring

Response message

Example response

{
  "code": "200",
  "message": "Success"
}