Home
API Reference

Submit Task

post
https://api.topview.ai/common-task/video-object-remove/submit

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
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).

Allowed:
string
required

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

selectionBox
object

Selection area in percent of video width/height (0~100). Required for clear-inside and clear-outside modes; may be omitted for auto mode. Constraints: x+w ≤ 100, y+h ≤ 100, and after mapping to pixels the shorter edge must be ≥ 4 pixels. Reference Doc

string

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

string

Optional associated Board ID

Headers
string
required
Defaults to <your-topview-uid>

User ID

string
required
Defaults to Bearer <your-api-key>

API Key for authentication

Response

Updated 2 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago