API Documentation

Authorization: Bearer YOUR_API_KEY

curl -X POST "https://vidmage.ai/api/v1/files/upload" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "capability": "video-upscaler", "parameter": "videoURL", "duration": 7.25, "fileName": "input.mp4", "localPath": "./input.mp4", "contentType": "video/mp4", "fileSize": 12345678 }'
# -> { "uploadCommand": "curl ...", "fileUrl": "https://..." }
# Run uploadCommand once, then use fileUrl in the generation request.

curl -H "Authorization: Bearer YOUR_API_KEY" "https://vidmage.ai/api/v1/capabilities"

curl -H "Authorization: Bearer YOUR_API_KEY" "https://vidmage.ai/api/v1/openapi.json" --output vidmage-openapi.json

curl -H "Authorization: Bearer YOUR_API_KEY" "https://vidmage.ai/api/v1/tasks/recent?limit=10"

const submitResponse = await fetch('https://vidmage.ai/api/v1/face-swap/submit', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VIDMAGE_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "targetImageUrl": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp",
  "referenceFaceImageUrl": "https://vidmage.ai/assets/images/samples/smiling-man-sweater.webp"
}),
})

const submitted = await submitResponse.json()
if (!submitResponse.ok || !submitted.success) {
  throw new Error(submitted.message ?? submitted.error ?? 'Task submission failed')
}
const taskId = submitted["taskId"]
if (!taskId) throw new Error('Submit succeeded without a task id')

while (true) {
  await new Promise(resolve => setTimeout(resolve, 5000))
  const queryResponse = await fetch('https://vidmage.ai/api/v1/face-swap/query', {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.VIDMAGE_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ taskId: taskId }),
  })
  const queried = await queryResponse.json()
  if (!queryResponse.ok || !queried.success) {
    throw new Error(queried.message ?? queried.error ?? 'Task query failed')
  }
  const data = queried.data ?? queried
  const status = String(data.status ?? '').toLowerCase()
  if (['success', 'succeeded', 'completed'].includes(status)) {
    console.log(queried.result ?? queried["imageUrl"] ?? data["imageUrl"])
    break
  }
  if (['failed', 'error'].includes(status)) {
    throw new Error(data.errorDetail ?? data.error ?? 'Task failed')
  }
}

import os
import time
import requests

submit_response = requests.post(
    "https://vidmage.ai/api/v1/face-swap/submit",
    headers={
        "Authorization": f"Bearer {os.environ['VIDMAGE_API_KEY']}",
    },
    json={
    "targetImageUrl": "https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp",
    "referenceFaceImageUrl": "https://vidmage.ai/assets/images/samples/smiling-man-sweater.webp",
},
    timeout=60,
)
submitted = submit_response.json()
if not submit_response.ok or not submitted.get("success"):
    raise RuntimeError(submitted.get("message") or submitted.get("error") or "Task submission failed")
task_id = submitted["taskId"]
if not task_id:
    raise RuntimeError("Submit succeeded without a task id")

while True:
    time.sleep(5)
    query_response = requests.post(
        "https://vidmage.ai/api/v1/face-swap/query",
        headers={"Authorization": f"Bearer {os.environ['VIDMAGE_API_KEY']}"},
        json={"taskId": task_id},
        timeout=60,
    )
    queried = query_response.json()
    if not query_response.ok or not queried.get("success"):
        raise RuntimeError(queried.get("message") or queried.get("error") or "Task query failed")
    data = queried.get("data") or queried
    status = str(data.get("status") or "").lower()
    if status in {"success", "succeeded", "completed"}:
        print(queried.get("result") or queried.get("imageUrl") or data.get("imageUrl"))
        break
    if status in {"failed", "error"}:
        raise RuntimeError(data.get("errorDetail") or data.get("error") or "Task failed")