Object Remover API documentation
Remove objects from an image using a mask.
Endpoints
| Contract item | Value |
|---|---|
| Capability | object-remover |
| Submit | POST https://vidmage.ai/api/v1/object-remover/submit |
| Query | POST https://vidmage.ai/api/v1/object-remover/query |
| Task identifier | taskId |
| Result field | imageUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: AI Object Remover API for Masked Image Cleanup
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
imageURL | string | Yes | Not specified | URL of the source image. |
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. |
Example request
{
"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"
}# 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": ... }Task results and recovery
URL of the result image with objects removed. Read imageUrl from the completed query response. Preserve taskId while the task is running.
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://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| Per request | 1 credits / image | — |
A fixed credit charge applies to this API request.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.