Image to Image
POST /api/v1/image-to-image/submit
imageUrls is required and prompt is required.
Required inputs
imageUrlsstring[]- Input image URLs (at least one).
promptstring- Text instruction describing the desired transformation.
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/image-to-image/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"imageUrls":["https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp"],"prompt":"Transform the uploaded portrait into a refined watercolor illustration while preserving the face and pose","aspectRatio":"9:16","resolution":"2k","width":"1080","height":"1920"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Parameters and input rules6 fields
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
imageUrls | string[] | Yes | Not specified | Input image URLs (at least one). Minimum items: 1 |
prompt | string | Yes | Not specified | Text instruction describing the desired transformation. No additional field constraint listed. |
aspectRatio | string | No | "9:16" | Preferred output aspect ratio. Values: "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3", "5:4", "4:5", "21:9", "1:4", "4:1", "1:8", "8:1" · Default: "9:16" |
resolution | string | No | "2k" | Output resolution tier. Exact pixel dimensions depend on the chosen aspect ratio. Values: "1k", "2k", "4k" · Default: "2k" |
width | string | No | "1080" | Legacy width hint used with height to infer aspect ratio when aspectRatio is omitted. It does not guarantee exact output pixels. Default: "1080" |
height | string | No | "1920" | Legacy height hint used with width to infer aspect ratio when aspectRatio is omitted. It does not guarantee exact output pixels. Default: "1920" |
Retrieve the result
Save taskId from the accepted submission and send it to this endpoint:
POST /api/v1/image-to-image/query
Use the same Bearer API key. On completion, read the imageUrl result field.
curl -X POST "https://vidmage.ai/api/v1/image-to-image/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "https://..." } }
