API Reference

Create remove-object video task

Remove objects from a source video using an aligned mask video. First create task inputs by reusing both tracking storage IDs or uploading source and mask videos with Create remove-object video task inputs.

Set is_preview=true to process only the first 5 seconds.

Poll Get remove-object video task status until COMPLETED or FAILED, then download the result from its temporary download_signed_url.

Credit: 8/second

post/v1/videos/remove-object

Authorization — This endpoint requires an API key. Pass it in the api-key header on every request. Learn more

Average processing time

For a 10-second input video.

Processing time
≈ 37.5 s

Measured with 1280 px input video.

Input requirements

Videos

Formats
MP4, MOV
Maximum longest edge
1280 px
Maximum duration
300 seconds (5 minutes)

Source and mask videos must have the same resolution, spatial alignment, and timeline.

View all input requirements

Parameters

NameTypeStatusDescription
task_id
stringRequiredTask identifier returned by the standard removal upload endpoint.
is_preview
booleanOptionalWhen true, process only the first 5 seconds.(default: false)

Responses

Removal task submittedRemoveObjectVideoCreatedResponse

FieldTypeDescription
task_idstringUnique task identifier.
curl -X POST "https://api.snapedit.app/v1/videos/remove-object" \
  -H "api-key: YOUR_API_KEY" \
  -F "task_id=value" \
  -F "is_preview=false"
Response
{
  "task_id": "removal-task-id"
}

Examples (2 examples)

Play or pause one video to control the whole comparison.

Parameters

Reuse input_video_id and mask_video_id; is_preview: false

Input

Output