开发者 API 目前仍处于 Beta 阶段,接口可能随时调整,现阶段更适合个人测试与体验,暂不建议用于生产环境。
通过 REST 调用当前部署已开放的 59 项能力,也可以在兼容 MCP 的 AI 工具中直接使用。访问 API 需要有效订阅。
Codex MCP、REST、Claude Code、Cursor 和手动 MCP 客户端统一使用专用 API Key。Codex 将静态 Authorization Header 保存在用户级配置中;不要把 Key 发进聊天或写入 Shell 历史。
Codex MCP、REST 与手动客户端统一使用绑定订阅的 API Key。
Authorization: Bearer YOUR_API_KEY订阅失效时请求返回 403,续订后原有 Key 会恢复使用。只有 ACCOUNT_SESSION_REFRESH_REQUIRED 可通过重新登录一次 VidMage 修复;其他 401 请按各自的恢复动作处理。
使用短时、绑定文件大小的 URL,将本地图片、视频或音频直接上传到对象存储。文件内容不会经过 VidMage 应用服务器。
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.# ~/.codex/config.toml
# Direct, persistent user-level MCP registration; this is not a plugin install.
# Replace any existing [mcp_servers.vidmage] table; do not append a duplicate.
[mcp_servers.vidmage]
url = "https://vidmage.ai/api/mcp"
http_headers = { Authorization = "Bearer YOUR_API_KEY" }
enabled = true
required = true
startup_timeout_sec = 30
tool_timeout_sec = 120
# Save this file, then confirm persistence with: codex mcp get vidmage
# Restrict the user-level file after saving: chmod 600 ~/.codex/config.toml
# Diagnose this direct server from VidMage startup errors; a remote Plugins catalog 401 is unrelated.
# Fully restart Codex, create a new task, and call list_capabilities.能力已知时跳过发现。本地文件只调用一次 upload_files,并行执行全部 uploadCommand。submit_task 只调用一次,之后按 retryAfterMs 查询同一任务;若返回 NEEDS_INPUT,展示已修正颜色的原生预览、调用一次 select_faces,再继续查询原任务。
list_models → estimate_model_creditsMCP 请求需要绑定有效订阅的 API Key。
upload_files(单次批量准备,并行 PUT)
→ submit_task + 全新稳定的 idempotencyKey(仅一次)
→ 等待 retryAfterMs 后调用 get_task_result
→ 仅在 NEEDS_INPUT 时调用 select_faces
→ 继续查询同一任务
→ 原生结果所有 AI 任务均为异步任务。每项能力提供两个端点:
| 端点 | 说明 |
|---|---|
| GET /api/v1/capabilities | 每个请求都必须使用与订阅账户绑定的 API Key 进行鉴权。 |
| GET /api/v1/openapi.json | 每个请求都必须使用与订阅账户绑定的 API Key 进行鉴权。 |
| POST /api/v1/files/upload | 为本地媒体文件创建受限的临时直传 URL。 |
| GET /api/v1/tasks/recent | 在超时、断连或响应丢失后恢复最近的任务 ID。 |
| POST /api/v1/<capability>/submit | 创建任务,并立即返回任务 ID。 |
| POST /api/v1/<capability>/query | 通过任务 ID 查询状态;完成后返回结果 URL。 |
curl -X POST "https://vidmage.ai/api/v1/face-swap/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"targetImageUrl":"https://vidmage.ai/assets/images/samples/blue-eyed-woman-sunlight.webp","referenceFaceImageUrl":"https://vidmage.ai/assets/images/samples/smiling-man-sweater.webp"}'
# -> { "success": true, "taskId": "...", "creditsRequired": ..., "creditsConsumed": 0, "usageDeferred": true }curl -X POST "https://vidmage.ai/api/v1/face-swap/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "https://..." } }能力目录和 OpenAPI 3.1 文档与运行时参数校验共用同一份契约。可将规范导入 Postman、Insomnia、Bruno 或 API 客户端生成器。
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.jsoncurl -H "Authorization: Bearer YOUR_API_KEY" "https://vidmage.ai/api/v1/tasks/recent?limit=10"以下示例只提交一次任务,并持续查询同一任务 ID 直至完成。重试同一次提交时,请保持 idempotency key 不变。
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")使用 HTTP 状态码控制程序流程,并根据 errorType 执行具体恢复操作。每个 REST 响应都包含 X-Request-Id,便于链路追踪和问题排查。
| 状态码 | 常见 errorType | 建议处理方式 |
|---|---|---|
| 400 | INVALID_JSON / VALIDATION_ERROR | 根据 details 修正字段;不要使用完全相同的参数重复请求。 |
| 401 | AUTHENTICATION_REQUIRED | VidMage 未收到凭据。请在 Codex 用户级配置或目标客户端中添加 Authorization;不要在聊天中索要或粘贴 API Key。 |
| 401 | AUTHORIZATION_HEADER_INVALID | 将 Authorization Header 修正为严格的 Bearer <API_KEY>;此次没有提交任务。 |
| 401 | API_KEY_INVALID_OR_REVOKED | 创建新的 API Key,仅替换现有配置中的 Authorization;重启 Codex,并在新任务中验证。 |
| 401 | API_KEY_INVALID_CREDENTIAL | 创建新的 API Key,并替换目标客户端中的凭据;现有凭据无法解密。 |
| 401 | ACCOUNT_SESSION_REFRESH_REQUIRED | 重新登录一次 VidMage;系统会刷新现有 API Key 包装的后端账户凭据,无需修改客户端配置。 |
| 401 REST | NEED_API_KEY | 仅用于 REST 兼容:提供 API Key。 |
| 402 | NEED_PURCHASE_CREDITS | 购买更多积分,或选择积分消耗更低的操作。 |
| 403 | NEED_SUBSCRIBE | 开通或续订账户订阅。 |
| 404 | CAPABILITY_NOT_ENABLED | 重新获取能力目录。该能力可能已关闭,或当前部署未提供。 |
| 409 | UPLOAD_NOT_READY / IDEMPOTENCY_CONFLICT / IDEMPOTENCY_IN_PROGRESS | 若提交仍在处理中,等待提示时间并复用相同 idempotencyKey;只有不同生成请求才创建新 Key。 |
| 410 | UPLOAD_EXPIRED | 请重新创建临时上传;之前的文件 URL 已过期。 |
| 429 | RATE_LIMITED | 等待 Retry-After 指定的时间,再使用有上限的指数退避重试。 |
| 503 | CREDENTIAL_STORAGE_UNAVAILABLE | 遵守 Retry-After,最多重试一次。若仍失败,请停止、报告 requestId,并请运维恢复 Developers MySQL readiness。保留原 Key,不要重新提交。 |
| 503 / MCP | SUBMISSION_OUTCOME_UNKNOWN / BILLING_OUTCOME_UNKNOWN / REFUND_OUTCOME_UNKNOWN | 优先遵循 recovery:GET_RECENT_TASKS 表示调用 get_recent_tasks;QUERY_TASK_ID_OR_CONTACT_SUPPORT 表示查询同一 taskId 或联系支持;CONTACT_SUPPORT_WITH_IDEMPOTENCY_KEY_AND_BUSINESS_ID 表示携带 idempotencyKey 和 businessId 联系支持。绝不要创建新的 idempotencyKey、重新提交或重复退款。 |
| 503 / MCP | TASK_PERSISTENCE_UNCERTAIN | 保留 taskId,不要重新提交;若问题持续,请携带 taskId 联系支持。 |
| MCP | TASK_QUERY_INTERRUPTED | 继续轮询同一 taskId;不要另行提交任务。 |
| MCP | RESULT_MISSING | 继续轮询同一 taskId,不要重新提交任务。 |
| 404 / MCP | TASK_NOT_FOUND | 任何重试前先调用 get_recent_tasks,不要重新提交付费任务。 |
| 502 / MCP | BILLING_INVARIANT_FAILED | 不要重试、更换 API Key、修改原 Idempotency-Key 或重新提交。请携带响应中的 taskId(若有)、capability 和原 Idempotency-Key 联系支持;REST 还应提供 X-Request-Id。 |
| 5xx | *_SERVICE_UNAVAILABLE / UPSTREAM_* | 其他 5xx 可使用有上限的指数退避重试,并保留任务 ID;此规则不适用于 CREDENTIAL_STORAGE_UNAVAILABLE。 |
以下参数组成 submit 的请求体。轮询 query 时,请使用相同的任务 ID 字段。