Skip to content
/V1.0

Run an AI Video Background Replace 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:
background_modestring

How the background image (the ref file) is fit onto the source video. crop keeps the background's aspect ratio and crops it to fill; stretch scales the background to the source video's dimensions.

Default:"crop"
Enum:"crop""stretch"
src_file_urlstringrequired

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

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

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

Example:"https://example.com/accessory.jpg"
POST
/s2s/v2.0/task/bg-replace-vid
curl -i -X POST \
  https://yce-api-01.makeupar.com/s2s/v2.0/task/bg-replace-vid \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "src_file_url": "https://example.com/cat_video.mp4",
    "ref_file_url": "https://example.com/accessory.jpg",
    "background_mode": "crop"
  }'

Responses

Successful execution of the task

Bodyapplication/json
statusinteger

Response status

Example:200
dataobject
Response
{
  "status": 200,
  "data": {
    "task_id": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
  }
}