Object Remover
POST /api/v1/object-remover/submit
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.
# 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
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
imageURL | string | Yes | Not specified | URL of the source image. No additional field constraint listed. |
maskURL | string | Yes | Not specified | 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. 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.
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://..." } }

