API para sa mga developer · v1

API sa pagpapalit ng mukha para sa mga larawan, video, GIF at panggrupong larawan

Gamitin ang parehong pipeline ng gawain sa produksyon gaya ng mga FaceSwapAI web studio sa pamamagitan ng mga stable na bersyong ruta. Ang pagpapatunay, tunay na mga formula ng kredito, mga limitasyon ng file, mga estado ng gawain at pag-uugali ng pagkabigo ay nakadokumento mula sa mga tumatakbong humahawak.

Live na kontrata sa produksyon · OpenAPI 3.1 · Na-update noong Agosto 30, 2026

Mabilis na pagsisimula

Lumikha ng isang susi sa iyong na-verify na account, magpadala ng isang multipart na kahilingan mula sa iyong server, pagkatapos ay i-poll ang katugmang ruta ng GET kasama ang ibinalik na taskId. Panatilihin ang sikreto sa labas ng mga bundle ng browser at mobile client.

  1. 1Lumikha at kumopya ng key nang isang beses
  2. 2Magsumite ng lokal na media nang may pahintulot=totoo
  3. 3Mag-poll habang PENDING o PROCESSING ang status
cURL
curl --request POST https://faceswapai.com/api/v1/face-swap/image \
  --header "Authorization: Bearer $FACESWAPAI_API_KEY" \
  --form "sourceImage=@./source.jpg" \
  --form "targetImage=@./target.jpg" \
  --form "consent=true"

Mga Endpoint at eksaktong pagpepresyo

Paraan ng HTTPRuta ng APILayuninPormula ng kredito
POST/api/v1/face-swap/imagePagpalit ng mukha ng larawan6
POST/api/v1/face-swap/videoPagpapalit ng mukha sa videomax(9, 3 × ceil(serverMeasuredInputSeconds))
POST/api/v1/face-swap/gifGIF pagpapalit ng mukhamax(9, 3 × ceil(serverMeasuredInputSeconds))
POST/api/v1/face-swap/multiplePagpapalitan ng larawang maramihang mukha6 × selectedTargetFaces
GET/api/v1/tasksKasaysayan ng gawain0

Mga halimbawa ng kreditong nagtrabaho

Isang image task66 na mga kredito
Apat na segundong videomax(9, 3 × ceil(4))12 na mga kredito
Walong segundong GIFmax(9, 3 × ceil(8))24 na mga kredito
Labingwalong segundong GIFmax(9, 3 × ceil(18))54 na mga kredito

Humiling ng mga field ayon sa endpoint

Piliin ang ruta sa pamamagitan ng target na media, pagkatapos ay ipadala ang eksaktong multipart na mga field sa ibaba. Ang mga opsyonal na kontrol sa pagpapanumbalik ay tumatanggap ng mga numero mula 0 hanggang 1.

POST/api/v1/face-swap/image

Pagpalit ng mukha ng larawan

Ilapat ang isang pinagmulang pagkakakilanlan sa isang target na larawan.

Kinakailangan
sourceImagetargetImageconsent=true
Opsyonal
faceRestoreVisibilityrestoreVisibility
POST/api/v1/face-swap/video

Pagpapalit ng mukha sa video

Maglapat ng isang pinagmulang pagkakakilanlan sa kabuuan ng isang na-upload na target na video.

Kinakailangan
sourceImagetargetVideoconsent=true
Opsyonal
faceRestoreVisibilityrestoreVisibility
POST/api/v1/face-swap/gif

GIF pagpapalit ng mukha

Maglapat ng isang pinagmulang pagkakakilanlan sa kabuuan ng isang na-upload na target na GIF.

Kinakailangan
sourceImagetargetGifconsent=true
Opsyonal
faceRestoreVisibilityrestoreVisibility
POST/api/v1/face-swap/multiple

Pagpapalitan ng larawang maramihang mukha

Palitan ang isa hanggang sampung napiling mukha sa isang larawan ng grupo.

Kinakailangan
sourceImagetargetFace0consent=true
Opsyonal
targetFace1...targetFace9faceBox0...faceBox9
GET/api/v1/tasks

Kasaysayan ng gawain

Maglista ng mga gawain na pagmamay-ari ng na-authenticate na account.

Opsyonal
pagepageSizestatustaskType

I-poll ang bawat gawain ng media

Pagkatapos magbalik ng taskId ang media POST, magpadala ng GET sa parehong media route gamit ang taskId bilang query parameter habang PENDING o PROCESSING ang status. Terminal ang COMPLETED, FAILED at CANCELLED.

Pagpapatunay ng maydala

Ipadala ang susi sa bawat kahilingan bilang Awtorisasyon: Tagadala YOUR_API_KEY. Ang API key ay namamana ng na-verify na account at ang live na balanse ng credit nito. Ang na-authenticate na limitasyon sa antas ng aplikasyon ay 300 kahilingan kada minuto; nananatiling nakadepende sa pila ang kapasidad ng henerasyon.

HTTP
Authorization: Bearer YOUR_API_KEY

Mga halimbawa ng JavaScript at Python

Ang mga halimbawa sa panig ng server na ito ay nagsusumite ng dalawang lokal na file, tinatanggihan ang mga pagkabigo sa HTTP, i-poll ang katugmang ruta ng gawain at i-print ang pansamantalang URL ng resulta. Ang bawat field ay nagmula sa live na kontrata ng OpenAPI.

JavaScriptNode.js 18+
JavaScript · Node.js 18+
import { readFile } from 'node:fs/promises';

const apiUrl = 'https://faceswapai.com/api/v1/face-swap/image';
const headers = {
  Authorization: 'Bearer ' + process.env.FACESWAPAI_API_KEY,
};
const form = new FormData();
form.set('sourceImage', new Blob([await readFile('./source.jpg')]), 'source.jpg');
form.set('targetImage', new Blob([await readFile('./target.jpg')]), 'target.jpg');
form.set('consent', 'true');

const submitted = await fetch(apiUrl, { method: 'POST', headers, body: form });
if (!submitted.ok) throw new Error(submitted.status + ': ' + await submitted.text());
const { taskId } = await submitted.json();

let task;
do {
  await new Promise((resolve) => setTimeout(resolve, 2000));
  const polled = await fetch(apiUrl + '?taskId=' + encodeURIComponent(taskId), { headers });
  if (!polled.ok) throw new Error(polled.status + ': ' + await polled.text());
  task = await polled.json();
} while (task.status === 'PENDING' || task.status === 'PROCESSING');

console.log(task.status === 'COMPLETED' ? task.result?.url : task.result?.error);
Pythonrequests 2.x
Python · requests 2.x
import os
import time
import requests

api_url = "https://faceswapai.com/api/v1/face-swap/image"
headers = {"Authorization": "Bearer " + os.environ["FACESWAPAI_API_KEY"]}

with open("source.jpg", "rb") as source, open("target.jpg", "rb") as target:
    response = requests.post(
        api_url,
        headers=headers,
        files={"sourceImage": source, "targetImage": target},
        data={"consent": "true"},
        timeout=60,
    )
response.raise_for_status()
task_id = response.json()["taskId"]

while True:
    time.sleep(2)
    response = requests.get(api_url, headers=headers, params={"taskId": task_id}, timeout=30)
    response.raise_for_status()
    task = response.json()
    if task["status"] not in ("PENDING", "PROCESSING"):
        break

result = task.get("result") or {}
print(result.get("url") if task["status"] == "COMPLETED" else result.get("error"))

Isumite, pagkatapos ay i-poll

Inilalaan ng matagumpay na POST ang kinakailangang credits at ibinabalik ang taskId. I-poll ang parehong media route habang PENDING o PROCESSING ang status. Terminal ang COMPLETED, FAILED at CANCELLED. Eksaktong isang beses nire-refund ng queue o provider failure ang nakabinbing reservation.

cURL
curl --get https://faceswapai.com/api/v1/face-swap/image \
  --header "Authorization: Bearer $FACESWAPAI_API_KEY" \
  --data-urlencode "taskId=YOUR_TASK_ID"
PENDING
Tinanggap at nakapila
PROCESSING
Tumatakbo
COMPLETED
Available ang resulta
FAILED
Huminto nang may pampublikong error
CANCELLED
Kinansela

Mga format at limitasyon

Tumatanggap ang mga imahe ng JPG, PNG, WebP, GIF, BMP, HEIC o HEIF hanggang 30 MB. Tumatanggap ang video ng MP4, MOV, WebM o AVI hanggang 100 MB at 600 segundo. Ang 100 MB ay mga 1–2 minuto ng karaniwang 1080p na video mula sa phone, kaya i-compress o paikliin ang mas mahahabang clip. Ang mga target na GIF ay limitado sa 30 MB at 30 segundo. Ang mga input ng maramihang mukha ay limitado sa 15 MB bawat isa at sampung napiling mukha.

Mga error sa HTTP at muling pagsubok

Huwag subukang muli ang 400, 401, 402, 403 o 413 na mga tugon nang hindi binabago ang kahilingan o katayuan ng account. Bumalik sa 429. Ang 500 o 503 ay maaaring subukang muli pagkatapos ng pagkaantala; ang mga pagpapareserba sa kredito ay protektado ng landas ng refund ng gawain.

Mga kasalukuyang hangganan ng produksyon

Magplano laban sa pampublikong v1 na kontrata na umiiral ngayon, kasama ang hindi nito inaangkin.

  • Ang mga gawain sa media ay asynchronous at gumagamit ng polling. Ang kasalukuyang pampublikong v1 na kontrata ay hindi naglalantad ng webhook.
  • Walang pampublikong ruta ng batch, field ng idempotency-key, ruta ng live-camera, na-publish na SLA o garantisadong oras ng pagkumpleto.
  • Ang mga API key ay nabibilang sa isang protektadong server. Ang mga resulta ay pansamantala, ang kapasidad ng pagbuo ay nakadepende sa queue at ang mga tinatanggap na pagkabigo ay gumagamit ng nakadokumentong landas ng refund.

Pahintulot, privacy at watermark

Ang bawat henerasyon ay nangangailangan ng consent=true, ibig sabihin, mayroon kang pahintulot na gamitin ang bawat na-upload na mukha. Pansamantala ang task media. Walang libreng pagsubok: bawat gawain ay binabayaran gamit ang one-time credits, at walang watermark at walang email ng account ang bawat resulta.

FAQ ng Face Swap API

Mayroon bang libreng Face Swap API key?

Ang paggawa ng API key ay libre. Ginagamit ng henerasyon ang balanse sa kredito ng account. Walang libreng pagsubok o libreng API tier: bawat gawain ay binabayaran gamit ang one-time credits, mula 600 credits sa halagang $19.99.

Sinusuportahan ba ng API ang video at maraming mukha?

Oo. Ang mga bersyong ruta ay sumasaklaw sa larawan, video, GIF at mga gawaing larawan sa maraming mukha. Ang pagpepresyo ng video at GIF ay kinakalkula mula sa nasusukat na metadata ng media.

Paano ko malalaman kung handa na ang isang resulta?

Basahin ang taskId mula sa tugon ng POST at i-poll ang katugmang GET route habang PENDING o PROCESSING ang status. Kasama sa COMPLETED ang pansamantalang result URL; terminal din ang FAILED at CANCELLED.

Maaari ko bang tawagan ang API nang direkta mula sa isang browser?

Huwag ilantad ang isang lihim na key sa browser code. Magpadala ng mga kahilingan mula sa iyong sariling server, walang server na function o iba pang protektadong backend.