As APIs para programadores ainda estão em fase beta e podem mudar a qualquer momento. Nesta fase, são mais adequadas para testes e experiências pessoais e ainda não são recomendadas para utilização em produção.
Aceda por REST às 59 capacidades ativadas nesta implementação ou utilize-as diretamente em ferramentas de IA compatíveis com MCP. É necessária uma subscrição ativa.
O Codex MCP, REST, Claude Code, Cursor e os clientes MCP manuais usam chaves API dedicadas. O Codex guarda o cabeçalho Authorization estático na configuração do utilizador; nunca envie uma chave pelo chat ou histórico da shell.
Cada pedido é autenticado com uma chave API associada à sua subscrição.
Authorization: Bearer YOUR_API_KEYUma subscrição expirada devolve 403 e as chaves API existentes voltam a funcionar após a renovação. Apenas ACCOUNT_SESSION_REFRESH_REQUIRED é corrigido ao iniciar sessão uma vez no VidMage; siga a recuperação específica para os outros erros 401.
Utilize um URL de curta duração e associado ao tamanho para carregar imagens, vídeos ou áudio diretamente para o armazenamento. Os bytes do ficheiro não passam pelo servidor da aplicação 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.Chame primeiro list_capabilities. Para gerar, use um idempotencyKey novo e estável, chame submit_task exatamente uma vez e consulte depois o mesmo taskId. Se a resposta se perder, chame primeiro get_recent_tasks; reutilize a chave original apenas numa repetição de transporte do mesmo envio.
list_models → estimate_model_creditsCada pedido é autenticado com uma chave API associada à sua subscrição.
list_capabilities (texto para imagem)
→ describe_capability
→ submit_task + idempotencyKey novo e estável (uma vez)
→ get_task_result (consultar a mesma tarefa)
→ get_recent_tasks (só se a resposta se perder)
→ resultado de imagem nativoTodas as tarefas de IA são assíncronas. Cada capacidade disponibiliza dois endpoints:
| Endpoint | Descrição |
|---|---|
| GET /api/v1/capabilities | Cada pedido é autenticado com uma chave API associada à sua subscrição. |
| GET /api/v1/openapi.json | Cada pedido é autenticado com uma chave API associada à sua subscrição. |
| POST /api/v1/files/upload | Cria um URL temporário e restrito de carregamento direto para um ficheiro multimédia local. |
| GET /api/v1/tasks/recent | Recupera IDs de tarefas recentes após tempo limite, desconexão ou resposta perdida. |
| POST /api/v1/<capability>/submit | Inicia uma tarefa e devolve imediatamente o respetivo ID. |
| POST /api/v1/<capability>/query | Consulta uma tarefa pelo ID e devolve o estado e o URL do resultado quando estiver concluída. |
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://..." } }O catálogo de capacidades e o documento OpenAPI 3.1 são gerados a partir do mesmo contrato utilizado para validar pedidos. Importe a especificação para o Postman, Insomnia, Bruno ou um gerador de clientes 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"Estes exemplos submetem uma tarefa uma única vez e consultam o mesmo ID até à conclusão. Mantenha a mesma chave de idempotência ao repetir a mesma submissão.
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")Utilize o estado HTTP para controlar o fluxo e errorType para definir a recuperação adequada. Cada resposta REST inclui o cabeçalho X-Request-Id para rastreio e suporte.
| Estado | errorType comum | Ação recomendada |
|---|---|---|
| 400 | INVALID_JSON / VALIDATION_ERROR | Corrija os campos indicados em details; não repita o mesmo pedido sem alterar os dados. |
| 401 | AUTHENTICATION_REQUIRED | O VidMage não recebeu credenciais. Adicione Authorization à configuração de utilizador do Codex ou ao cliente de destino; nunca peça nem cole uma chave API no chat. |
| 401 | AUTHORIZATION_HEADER_INVALID | Corrija o Authorization Header para exatamente Bearer <API_KEY>; nenhuma tarefa foi enviada. |
| 401 | API_KEY_INVALID_OR_REVOKED | Crie uma nova chave API e substitua apenas Authorization na configuração existente; reinicie o Codex e verifique numa nova tarefa. |
| 401 | API_KEY_INVALID_CREDENTIAL | Crie uma nova chave API e substitua a credencial no cliente de destino; não é possível desencriptar a credencial atual. |
| 401 | ACCOUNT_SESSION_REFRESH_REQUIRED | Inicie sessão uma vez no VidMage. O serviço atualiza a credencial de conta incluída nas chaves API existentes; a configuração do cliente não muda. |
| 401 REST | NEED_API_KEY | Apenas para compatibilidade REST: forneça uma chave API. |
| 402 | NEED_PURCHASE_CREDITS | Adicione créditos ou escolha uma operação de menor custo. |
| 403 | NEED_SUBSCRIBE | Ative ou renove a subscrição da conta. |
| 404 | CAPABILITY_NOT_ENABLED | Atualize a descoberta de capacidades. A capacidade está desativada ou não está disponível nesta implementação. |
| 409 | UPLOAD_NOT_READY / IDEMPOTENCY_CONFLICT / IDEMPOTENCY_IN_PROGRESS | Se o envio ainda estiver em curso, aguarde o tempo indicado e reutilize o mesmo idempotencyKey. Crie uma nova chave apenas para outro pedido de geração. |
| 410 | UPLOAD_EXPIRED | Crie um novo carregamento temporário; o URL anterior expirou. |
| 429 | RATE_LIMITED | Aguarde o período de Retry-After e tente novamente com recuo exponencial limitado. |
| 503 | CREDENTIAL_STORAGE_UNAVAILABLE | Respeite Retry-After e tente novamente apenas uma vez. Se persistir, pare, comunique requestId e peça às operações que restaurem Developers MySQL readiness. Mantenha a chave API e não reenvie. |
| 503 / MCP | SUBMISSION_OUTCOME_UNKNOWN / BILLING_OUTCOME_UNKNOWN / REFUND_OUTCOME_UNKNOWN | Siga primeiro recovery: GET_RECENT_TASKS significa chamar get_recent_tasks; QUERY_TASK_ID_OR_CONTACT_SUPPORT significa consultar o mesmo taskId ou contactar o suporte; CONTACT_SUPPORT_WITH_IDEMPOTENCY_KEY_AND_BUSINESS_ID significa contactar o suporte indicando idempotencyKey e businessId. Nunca crie um novo idempotencyKey, reenvie a tarefa ou tente outro reembolso. |
| 503 / MCP | TASK_PERSISTENCE_UNCERTAIN | Mantenha taskId, não reenvie a tarefa e, se o problema persistir, contacte o suporte indicando taskId. |
| MCP | TASK_QUERY_INTERRUPTED | Retome a consulta do mesmo taskId; não envie outra tarefa. |
| MCP | RESULT_MISSING | Continue a consultar o mesmo taskId; não reenvie a tarefa. |
| 404 / MCP | TASK_NOT_FOUND | Chame get_recent_tasks antes de tentar novamente; não reenvie uma tarefa paga. |
| 502 / MCP | BILLING_INVARIANT_FAILED | Não tente novamente, troque a chave API, altere o Idempotency-Key original nem reenvie a tarefa. Contacte o suporte indicando taskId se presente, capability e o Idempotency-Key original; para REST, inclua também X-Request-Id. |
| 5xx | *_SERVICE_UNAVAILABLE / UPSTREAM_* | Para outros erros 5xx, tente novamente com recuo exponencial limitado e conserve o ID da tarefa. Isto não se aplica a CREDENTIAL_STORAGE_UNAVAILABLE. |
Os parâmetros abaixo formam o corpo do pedido submit. Utilize o mesmo campo de ID da tarefa ao consultar query.