VidMage

VidMage is an AI video and image creation platform for creators. Turn your ideas and images into videos and fresh visuals.

Open the creator tools
Explore APIs
AI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
Build with VidMage
QuickstartAPI keysVidMage MCPError reference
Your account
Developer consoleAbout VidMagePlans and creditsAPI billingContact support
© 2026 VidMage. All rights reserved.
Privacy PolicyTerms of ServiceReport Abuse
Skip to content
VidMage/Developers
Overview
APIs
All APIsAI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
DocumentationVidMage MCPOpen console
Developers/AI Object Remover API for Masked Image Cleanup

AI Object Remover API for Masked Image Cleanup

Integrate object removal into your image editor using a source image and a removal mask. Submit both URLs and retrieve the processed image to display alongside the original.

Get API keyView API docs
Abstract illustration for AI Object Remover API for Masked Image Cleanup
PlaygroundAPIPricingGuideFAQs

AI Object Remover API Playground

Use your existing API key and subscription. Submitting a generation uses credits; uploading and preparing a request does not start a generation.

API access is available to subscribers only. Your subscription credits are shared across the website and the API.

View plans

Parameter

2 parameters

URL of the source image.

URL of the removal mask image. It must have the same pixel dimensions as imageURL; mark the region to remove in white and keep the rest black.

Request code

#!/usr/bin/env bash
set -euo pipefail
# Set this once per intended task; preserve it and the body for transport retries.
: "${VIDMAGE_IDEMPOTENCY_KEY:?Set a unique key for this task}"

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/object-remover/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "imageURL": "https://vidmage.ai/assets/models/runway-ai-video-generator/example-honey-macro.webp",
  "maskURL": "https://vidmage.ai/assets/models/runway-ai-video-generator/feature-motion-brush-mask.webp"
}')"
TASK_ID="$(printf '%s' "$SUBMIT_RESPONSE" | jq -er '.["taskId"]')"

while true; do
  QUERY_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/object-remover/query" \
    -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
    -H "Content-Type: application/json" \
    --data-raw "{\"taskId\":\"${TASK_ID}\"}")"
  STATUS="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.status // .data.status // "") | ascii_downcase')"
  case "$STATUS" in
    success|succeeded|completed)
      RESULT="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["imageUrl"] // .data["imageUrl"] // empty)')"
      if [ -z "$RESULT" ]; then
        printf '%s' "Result missing; preserve task $TASK_ID and query the same task again. Do not resubmit." >&2
        exit 2
      fi
      printf '%s\n' "$RESULT"
      break
      ;;
    needs_input)
      printf '%s' "Face selection required; preserve task $TASK_ID" >&2
      exit 2
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

Response data

Submit the task to see the API response here.
PlaygroundCapabilities

API documentation

Submit a request, track the task, and retrieve your result.

Required inputs
imageURL maskURL
Output
Image·imageUrl
Request setup & limitsHeaders, input options and media limits

Request headers

Authorization
Bearer YOUR_API_KEY

Keep your API key on your server.

Content-Type
application/json
Idempotency-Key
YOUR_UNIQUE_KEY

Use a new key per task. Reuse it only when retrying the same submission.

Input options & limits

Request controls follow each task's parameter rules; they do not guarantee output properties.

Object Remover

RequiredimageURL maskURL

Output dimensions and format are not specified in this reference.

Input retention and output-link lifetime depend on the API contract. Confirm API-specific retention terms before making promises to your users. Upload guide ↗

Object Remover

POST /api/v1/object-remover/submit

Full API documentation ↗

imageURL is required and maskURL is required.

Required inputs

imageURLstring
URL of the source image.
maskURLstring
URL of the removal mask image. It must have the same pixel dimensions as imageURL; mark the region to remove in white and keep the rest black.

Edit the sample inputs for your own task before submitting.

Object Remover request
# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/object-remover/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"imageURL":"https://vidmage.ai/assets/models/runway-ai-video-generator/example-honey-macro.webp","maskURL":"https://vidmage.ai/assets/models/runway-ai-video-generator/feature-motion-brush-mask.webp"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules2 fields
FieldTypeRequiredDefaultMeaning and limits
imageURLstringYesNot specifiedURL of the source image. No additional field constraint listed.
maskURLstringYesNot specifiedURL of the removal mask image. It must have the same pixel dimensions as imageURL; mark the region to remove in white and keep the rest black. No additional field constraint listed.

Retrieve the result

Save taskId from the accepted submission and send it to this endpoint:

POST /api/v1/object-remover/query

Use the same Bearer API key. On completion, read the imageUrl result field.

Task states and recovery ↗
Object Remover query
curl -X POST "https://vidmage.ai/api/v1/object-remover/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "https://..." } }

Pricing

See what one image, video, or generation costs in credits. Your API and website activity share the same credit balance.

API credit rates and calculated example request costs
API / workflowExample requestPrice (credits)
Object Removerimage API1 image request: 1 credit
How this is calculated
  • Per request: 1 credit / image

A fixed credit charge applies to this API request.

Estimate your own request ↗
1 credit / imageSee calculation details
Billed in credits. Shared with the website.Active subscription required. Unit rates and examples follow current API credit rules.Billing details⌄

Examples show the charge for the inputs listed above. Resolution, duration, audio, output count and reference media can change the total. Minimum charges and rounding follow the selected API.

Use the Playground to estimate your request before submitting it. Estimates do not start a generation. Subscription and credit-pack prices are listed on the plans page.

Your task’s recorded usage is the source of truth for the final charge.

View plans ↗Billing guide ↗

About AI Object Remover API

VidMage's AI Object Remover API is an image editing interface for removing selected objects. It accepts a source image and a removal mask that identifies the area to edit. The output is a processed image for comparison with the original, supporting editors with manual region selection. To select and remove an object in your browser, use VidMage's Object Remover.

AI Object Remover API capabilities

Mask-based object removal
Submit a source image and a separate mask to identify the area you want the service to remove.
Editor selection input
Connect a selection tool in your application to the mask asset supplied with each object removal request.
Processed image output
Retrieve the cleaned image and place it beside the original to inspect the selected region in context.

What you can build

Marketplace photo cleanup

A stray cable or price tag can distract from the item for sale. Your selection brush marks the unwanted area, and the image plus removal mask form the request. Sellers can inspect the cleaned region before updating the listing.

Travel photo retouching

Keep the view while removing a distracting bin or sign from a vacation photo. The traveler marks that object with a brush, producing the mask for the edit. A full-size result view supports inspection of the surrounding texture.

Campaign photo preparation

Before laying out a banner, a designer may need to remove a prop that competes with the headline. A mask-based cleanup step gives the design tool a way to revise that part of the source photo without rebuilding the whole composition.

How to use AI Object Remover API

  1. Get an API key

    Create a key in the Developer Console and store it on your server. Use it in the Authorization: Bearer header.

  2. Prepare and submit your inputs

    Set up your inputs in the Playground, then copy the matching API request. Send it from your server with a unique Idempotency-Key.

  3. Track the task

    Save the returned taskId and query the same operation until it completes. Keep that identifier if your app stops waiting.

  4. Retrieve the result

    Read imageUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Preserve the request casing
The source and mask fields are imageURL and maskURL, while the result is imageUrl. Preserve these exact names when connecting your editor to the request.
Confirm the mask encoding
The public schema does not define mask polarity, alpha handling, or dimensions. Verify your editor's exported mask format before using it in a removal workflow.

Input requirementsUpload local files

Task fields and results

Keep the task identifier with its original request and Idempotency-Key. Query the same capability until it completes, then read the documented result field.

Task identifier
taskId
Query route
POST /api/v1/object-remover/query
Completed result
imageUrl
Task states and response structure ↗
Errors, retries and limits

Retry transport failures with the same idempotency key only when the original submission may not have reached the server. For a confirmed task, keep querying the original task instead of submitting a duplicate.

Read error recovery guidance ↗

FAQs

Should I use object removal or watermark removal?

Use watermark removal for automatic cleanup of text or logo marks when you do not need to supply a mask. Neither cleanup endpoint accepts an editing prompt.

Are failed or timed-out requests charged?

A client timeout is not a confirmed task failure. Confirmed failures are automatically refunded only when the refund outcome is certain. Unknown charges or refunds remain pending reconciliation.

Failure and refund handling ↗
How long should my app wait for a result?

The checked contract does not establish a fixed completion time. Choose a local wait budget for your app; it is not an API completion deadline.

Polling and wait budgets ↗
What are the rate and concurrency limits?

Request-rate limits control how often you can call the API; concurrency limits control simultaneous work. The documentation ties both to the stable API key but does not publish numeric limits for this operation. Confirm account limits before planning parallel jobs.

Rate-limit recovery ↗
Can I receive results through a webhook?

The checked request contract documents status queries and does not list a webhook or callback field for these routes. Check the current authenticated OpenAPI contract before making a callback part of your integration.

Query task results ↗Check the current contract ↗

Explore more APIs on VidMage

  • AI Image Watermark Remover API for Cleanup↗
  • AI Clothes Changer API for Outfit Previews↗
  • AI Hairstyle Changer API for Photo Editing↗
  • GPT Image API↗
  • AI Image Upscaler API for 2x and 4x Requests↗
  • AI Image to Image API for Prompted Edits↗
  • Nano Banana API↗
  • Z-Image API↗