Run an AI Video Object Removal task.

Request

AI tasks are asynchronous. Prefer webhook-based completion handling when the feature supports webhooks. Configure your webhook endpoint, verify webhook signatures, and use the received task_id to query the task result after a success or error notification. See the webhook integration guide for setup and verification details.

If webhooks are not supported or cannot be used in your integration, implement polling. After submitting an AI task, poll the status endpoint at regular intervals (e.g., every 10 seconds) until the task status is success or error.

Security

BearerAuthenticationV2

Bodyapplication/jsonrequired

Any of:

frame_idxintegerrequired

Specifies the frame index in the input video that corresponds to the provided mask image, ranging from 0 to the total frame count minus 1.

Example:0

src_file_urlstringrequired

Url of the file to run task. The url should be publicly accessible.

Example:"https://example.com/cat_video.mp4"

msk_file_urlstringrequired

URL of the mask file. This should be a grey scale mask image with the exact same width and height with the input image where white pixels indicate foreground and black pixels represent background. The URL should be publicly accessible.

Example:"https://example.com/mask.jpg"

POST

/s2s/v2.0/task/obj-rem-vid

curl -i -X POST \
  https://yce-api-01.makeupar.com/s2s/v2.0/task/obj-rem-vid \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "src_file_url": "https://example.com/cat_video.mp4",
    "msk_file_url": "https://example.com/mask.jpg",
    "frame_idx": 0
  }'

Responses

Successful execution of the task

Bodyapplication/json

statusinteger

Response status

Example:200

dataobject

Response

{
  "status": 200,
  "data": {
    "task_id": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
  }
}