API для разработчиков всё ещё находятся на стадии бета-тестирования и могут измениться в любой момент. На данном этапе они больше подходят для личного тестирования и экспериментов и пока не рекомендуются для использования в рабочей среде.
Вызывайте через REST 59 функций, активированных в этом развертывании, или используйте их в MCP-совместимых ИИ-инструментах. Нужна активная подписка.
Codex MCP, REST, Claude Code, Cursor и ручные MCP-клиенты используют отдельные API-ключи. Codex хранит статический заголовок Authorization в пользовательской конфигурации; никогда не отправляйте ключ в чат или историю оболочки.
Каждый запрос аутентифицируется API-ключом, привязанным к подписке.
Authorization: Bearer YOUR_API_KEYИстёкшая подписка возвращает 403, а существующие API-ключи снова работают после продления. Только 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.Сначала вызовите list_capabilities. Для генерации используйте новый стабильный idempotencyKey, вызовите submit_task ровно один раз, затем опрашивайте тот же taskId. Если ответ потерян, сначала вызовите get_recent_tasks; повторно используйте исходный ключ только при транспортной повторной отправке того же запроса.
list_models → estimate_model_creditsКаждый запрос аутентифицируется API-ключом, привязанным к подписке.
list_capabilities (текст в изображение)
→ describe_capability
→ submit_task + новый стабильный idempotencyKey (ровно один раз)
→ get_task_result (опрос той же задачи)
→ get_recent_tasks (только если ответ потерян)
→ исходный результат изображенияВсе задачи ИИ выполняются асинхронно. Для каждой функции доступны два endpoint:
| Endpoint | Описание |
|---|---|
| GET /api/v1/capabilities | Каждый запрос аутентифицируется API-ключом, привязанным к подписке. |
| GET /api/v1/openapi.json | Каждый запрос аутентифицируется API-ключом, привязанным к подписке. |
| 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"Эти примеры отправляют задачу один раз и опрашивают тот же идентификатор до завершения. При повторной попытке той же отправки сохраняйте прежний ключ идемпотентности.
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 не получил учётные данные. Добавьте Authorization в пользовательскую конфигурацию Codex или целевой клиент; никогда не запрашивайте и не вставляйте API-ключ в чат. |
| 401 | AUTHORIZATION_HEADER_INVALID | Исправьте Authorization Header точно на Bearer <API_KEY>; задача не отправлялась. |
| 401 | API_KEY_INVALID_OR_REVOKED | Создайте новый API-ключ и замените только Authorization в существующей конфигурации; перезапустите Codex и проверьте в новой задаче. |
| 401 | API_KEY_INVALID_CREDENTIAL | Создайте новый API-ключ и замените учётные данные в целевом клиенте; текущие учётные данные невозможно расшифровать. |
| 401 | ACCOUNT_SESSION_REFRESH_REQUIRED | Один раз войдите в VidMage. Сервис обновит учётные данные серверного аккаунта внутри существующих API-ключей; конфигурация клиента не изменится. |
| 401 REST | NEED_API_KEY | Только для совместимости с REST: укажите API-ключ. |
| 402 | NEED_PURCHASE_CREDITS | Пополните кредиты или выберите менее затратную операцию. |
| 403 | NEED_SUBSCRIBE | Активируйте или продлите подписку аккаунта. |
| 404 | CAPABILITY_NOT_ENABLED | Обновите discovery функций. Функция отключена или отсутствует в этом развертывании. |
| 409 | UPLOAD_NOT_READY / IDEMPOTENCY_CONFLICT / IDEMPOTENCY_IN_PROGRESS | Если отправка ещё обрабатывается, подождите указанное время и повторно используйте тот же idempotencyKey. Создавайте новый ключ только для другого запроса генерации. |
| 410 | UPLOAD_EXPIRED | Создайте новую временную загрузку; прежний URL файла истёк. |
| 429 | RATE_LIMITED | Подождите время из Retry-After и повторите запрос с ограниченным экспоненциальным backoff. |
| 503 | CREDENTIAL_STORAGE_UNAVAILABLE | Соблюдайте Retry-After и повторите попытку только один раз. Если ошибка сохраняется, остановитесь, сообщите requestId и попросите оператора восстановить Developers MySQL readiness. Сохраните API-ключ и не отправляйте задачу повторно. |
| 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-ключ или исходный Idempotency-Key и не отправляйте задачу заново. Обратитесь в поддержку, указав taskId при наличии, capability и исходный Idempotency-Key; для REST также сообщите X-Request-Id. |
| 5xx | *_SERVICE_UNAVAILABLE / UPSTREAM_* | Для остальных ошибок 5xx используйте ограниченную экспоненциальную задержку и сохраните ID задачи. Это не относится к CREDENTIAL_STORAGE_UNAVAILABLE. |
Параметры ниже образуют тело запроса submit. При опросе query используйте то же поле ID задачи.