Interfejsy API dla deweloperów są nadal w wersji beta i mogą się zmienić w dowolnym momencie. Na tym etapie najlepiej nadają się do osobistych testów i eksperymentów i nie są jeszcze zalecane do użytku produkcyjnego.
Wywołuj przez REST funkcje włączone w tym wdrożeniu (59) lub używaj ich bezpośrednio w narzędziach AI zgodnych z MCP. Wymagana jest aktywna subskrypcja.
Codex MCP, REST, Claude Code, Cursor i ręczne klienty MCP używają dedykowanych kluczy API. Codex zapisuje statyczny nagłówek Authorization w konfiguracji użytkownika; nigdy nie wysyłaj klucza przez czat ani historię powłoki.
Każde żądanie jest uwierzytelniane kluczem API powiązanym z subskrypcją.
Authorization: Bearer YOUR_API_KEYWygasła subskrypcja zwraca 403, a istniejące klucze API działają ponownie po odnowieniu. Tylko ACCOUNT_SESSION_REFRESH_REQUIRED naprawia jednorazowe logowanie do VidMage; dla innych błędów 401 wykonaj właściwą akcję odzyskiwania.
Użyj krótkotrwałego adresu powiązanego z rozmiarem, aby przesłać obrazy, filmy lub dźwięk bezpośrednio do pamięci. Bajty pliku nie przechodzą przez serwer aplikacji 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.Najpierw wywołaj list_capabilities. Do generowania użyj nowego, stabilnego idempotencyKey, wywołaj submit_task dokładnie raz, a następnie odpytuj ten sam taskId. Jeśli odpowiedź zaginie, najpierw wywołaj get_recent_tasks; użyj ponownie pierwotnego klucza tylko przy ponowieniu transportu tego samego zgłoszenia.
list_models → estimate_model_creditsKażde żądanie jest uwierzytelniane kluczem API powiązanym z subskrypcją.
list_capabilities (tekst na obraz)
→ describe_capability
→ submit_task + nowy stabilny idempotencyKey (dokładnie raz)
→ get_task_result (odpytywanie tego samego zadania)
→ get_recent_tasks (tylko gdy odpowiedź zaginęła)
→ natywny wynik obrazuWszystkie zadania AI są asynchroniczne. Każda funkcja udostępnia dwa endpointy:
| Endpoint | Opis |
|---|---|
| GET /api/v1/capabilities | Każde żądanie jest uwierzytelniane kluczem API powiązanym z subskrypcją. |
| GET /api/v1/openapi.json | Każde żądanie jest uwierzytelniane kluczem API powiązanym z subskrypcją. |
| POST /api/v1/files/upload | Tworzy ograniczony, tymczasowy adres do bezpośredniego przesłania lokalnego pliku multimedialnego. |
| GET /api/v1/tasks/recent | Odzyskuje ID ostatnich zadań po przekroczeniu czasu, rozłączeniu lub utracie odpowiedzi. |
| POST /api/v1/<capability>/submit | Uruchamia zadanie i natychmiast zwraca jego identyfikator. |
| POST /api/v1/<capability>/query | Sprawdza zadanie według identyfikatora, a po zakończeniu zwraca stan i adres URL wyniku. |
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://..." } }Katalog funkcji i dokument OpenAPI 3.1 są generowane na podstawie tego samego kontraktu, który służy do walidacji żądań. Zaimportuj specyfikację do Postman, Insomnia, Bruno lub generatora klienta 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"Te przykłady przesyłają zadanie jeden raz i odpytują ten sam identyfikator aż do zakończenia. Przy ponawianiu tego samego zgłoszenia zachowaj ten sam klucz idempotency.
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")Używaj statusu HTTP do sterowania przepływem, a errorType do wyboru właściwego sposobu odzyskiwania. Każda odpowiedź REST zawiera nagłówek X-Request-Id ułatwiający śledzenie i pomoc techniczną.
| Status | Typowy errorType | Zalecane działanie |
|---|---|---|
| 400 | INVALID_JSON / VALIDATION_ERROR | Popraw pola wymienione w details; nie ponawiaj próby z tymi samymi, niezmienionymi danymi. |
| 401 | AUTHENTICATION_REQUIRED | VidMage nie otrzymał danych logowania. Dodaj Authorization do konfiguracji użytkownika Codex lub klienta docelowego; nigdy nie proś o klucz API ani nie wklejaj go na czacie. |
| 401 | AUTHORIZATION_HEADER_INVALID | Popraw Authorization Header dokładnie na Bearer <API_KEY>; żadne zadanie nie zostało wysłane. |
| 401 | API_KEY_INVALID_OR_REVOKED | Utwórz nowy klucz API i zastąp tylko Authorization w istniejącej konfiguracji; uruchom Codex ponownie i sprawdź w nowym zadaniu. |
| 401 | API_KEY_INVALID_CREDENTIAL | Utwórz nowy klucz API i zastąp dane uwierzytelniające w docelowym kliencie; obecnych danych nie można odszyfrować. |
| 401 | ACCOUNT_SESSION_REFRESH_REQUIRED | Zaloguj się raz do VidMage. Usługa odświeży dane konta zaplecza opakowane w istniejących kluczach API; konfiguracja klienta pozostaje bez zmian. |
| 401 REST | NEED_API_KEY | Tylko dla zgodności z REST: podaj klucz API. |
| 402 | NEED_PURCHASE_CREDITS | Dodaj kredyty lub wybierz tańszą operację. |
| 403 | NEED_SUBSCRIBE | Aktywuj lub odnów subskrypcję konta. |
| 404 | CAPABILITY_NOT_ENABLED | Odśwież wykrywanie funkcji. Funkcja jest wyłączona lub niedostępna w tym wdrożeniu. |
| 409 | UPLOAD_NOT_READY / IDEMPOTENCY_CONFLICT / IDEMPOTENCY_IN_PROGRESS | Jeśli zgłoszenie jest nadal przetwarzane, odczekaj wskazany czas i ponownie użyj tego samego idempotencyKey. Utwórz nowy klucz tylko dla innego żądania generowania. |
| 410 | UPLOAD_EXPIRED | Utwórz nowe tymczasowe przesłanie; poprzedni adres pliku wygasł. |
| 429 | RATE_LIMITED | Odczekaj czas Retry-After, a następnie ponów próbę z ograniczonym wykładniczym opóźnieniem. |
| 503 | CREDENTIAL_STORAGE_UNAVAILABLE | Przestrzegaj Retry-After i ponów próbę tylko raz. Jeśli błąd trwa, zatrzymaj się, zgłoś requestId i poproś operatora o przywrócenie Developers MySQL readiness. Zachowaj klucz API i nie wysyłaj ponownie. |
| 503 / MCP | SUBMISSION_OUTCOME_UNKNOWN / BILLING_OUTCOME_UNKNOWN / REFUND_OUTCOME_UNKNOWN | Najpierw wykonaj recovery: GET_RECENT_TASKS oznacza wywołanie get_recent_tasks; QUERY_TASK_ID_OR_CONTACT_SUPPORT oznacza odpytanie tego samego taskId lub kontakt z pomocą techniczną; CONTACT_SUPPORT_WITH_IDEMPOTENCY_KEY_AND_BUSINESS_ID oznacza kontakt z pomocą techniczną i podanie idempotencyKey oraz businessId. Nigdy nie twórz nowego idempotencyKey, nie wysyłaj zadania ponownie ani nie próbuj kolejnego zwrotu. |
| 503 / MCP | TASK_PERSISTENCE_UNCERTAIN | Zachowaj taskId, nie wysyłaj zadania ponownie, a jeśli problem się utrzymuje, skontaktuj się z pomocą techniczną i podaj taskId. |
| MCP | TASK_QUERY_INTERRUPTED | Wznów odpytywanie tego samego taskId; nie wysyłaj kolejnego zadania. |
| MCP | RESULT_MISSING | Nadal odpytuj ten sam taskId; nie wysyłaj zadania ponownie. |
| 404 / MCP | TASK_NOT_FOUND | Wywołaj get_recent_tasks przed ponowną próbą; nie wysyłaj ponownie płatnego zadania. |
| 502 / MCP | BILLING_INVARIANT_FAILED | Nie próbuj ponownie, nie zmieniaj klucza API ani pierwotnego Idempotency-Key i nie wysyłaj zadania ponownie. Skontaktuj się z pomocą techniczną, podając taskId, jeśli jest dostępny, capability oraz pierwotny Idempotency-Key; dla REST dołącz także X-Request-Id. |
| 5xx | *_SERVICE_UNAVAILABLE / UPSTREAM_* | Dla innych błędów 5xx użyj ograniczonego opóźnienia wykładniczego i zachowaj ID zadania. Nie dotyczy to CREDENTIAL_STORAGE_UNAVAILABLE. |
Poniższe parametry tworzą treść żądania submit. Podczas odpytywania przez query użyj tego samego pola identyfikatora zadania.