Skip to main content

Uncensored — This model declares no content filter. SpicyAPI forwards the request without adding a platform content scan; legal and consent duties remain with the customer.Browse every model at this filtering level
spicyapi/face-swap-v1/edit

Face Swap is SpicyAPI's image face swap. It transfers only the facial features from a reference photo onto a target image, keeping the target's head shape, hair, pose and background. Send two image URLs and an optional seed; no prompt.

From $0.013/image
Run model

Workbench

Send a request

Quickstart

Examples use the selected endpoint’s public parameter definitions. Replace the API key and example media, then send the request from your server.

SDKs & integrations
POSThttps://api.spicyapi.ai/api/v1/jobs/createTask

API authentication

Keep the API key in the server environment variable SPICY_API_KEY. Use Bearer authentication and Content-Type: application/json for JSON requests.

Authorization: Bearer $SPICY_API_KEY
Face Swap · Image Editing · Sample output
Sample outputUse this example
# Generate the idempotency key once; reuse it when retrying after a lost response.
export SPICY_IDEMPOTENCY_KEY="${SPICY_IDEMPOTENCY_KEY:-$(uuidgen)}"
curl -X POST https://api.spicyapi.ai/api/v1/jobs/createTask \
  -H "Authorization: Bearer $SPICY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SPICY_IDEMPOTENCY_KEY" \
  -d '{
  "model": "spicyapi/face-swap-v1/edit",
  "input": {
    "image_url": "https://example.com/reference.png",
    "reference_image_url": "https://example.com/reference.png",
    "style": "realistic"
  }
}'

# Copy data.taskId from the response into TASK_ID, then poll the status.
TASK_ID="TASK_ID_FROM_RESPONSE"
curl "https://api.spicyapi.ai/api/v1/jobs/recordInfo?taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Generated from this model’s input schema — the same one the API validates every request against.

Input parameters

Place these fields inside the request body’s input object. Names and types match the API. Do not assume a default when none is specified.

reference_image_urlstringRequired

The image supplying the facial features. Only the face is taken, not the head shape or hair. Pick one lit from roughly the same direction as the target.

Default
Not specified
Constraints
minLength:1
contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
image_urlstringRequired

The image being changed. This person's head shape, hair, pose, wardrobe and background are preserved — only their facial features are replaced.

Default
Not specified
Constraints
minLength:1
contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
seedintegerOptional

Reuse a seed to compare two runs over the same image pair against an identical draw; leave it empty or set 0 for a random draw each time. It is a comparison tool, not a guarantee of an identical result.

Default
Not specified
Constraints
minimum:0
maximum:2147483647
face_enhancebooleanOptional

Runs a face-enhancement pass on the swapped face for a higher-resolution face. Off by default. It does not change the price.

Default
false
stylestringOptional

Finish applied to the swapped face: realistic (the default) keeps natural skin tone and texture, beautify smooths and brightens the skin, lossless holds on to the most facial detail. It does not change the price.

Default
"realistic"
Allowed values
"realistic""beautify""lossless"
face_mappingarray<object>Optional

For group shots: list which face in the reference goes onto which face in the target, one pair per entry, with faces numbered from 0 in detection order. Leave it out to swap a single face. It does not change the price.

Default
Not specified
Constraints
maxItems:10

Track the task

HTTP 202 means the task was accepted, not completed. Save the returned taskId and query that task. Do not create another task while waiting for its result.

Accepted response
HTTP/1.1 202 Accepted
Location: /api/v1/jobs/recordInfo?taskId=job_01k3m8x9q2z4v7n5p6r8s0t1w3

{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_create",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "state": "queued",
    "estimatedCost": "0.750000"
  }
}

The accepted response includes the estimate so your app can show the same amount in task history and billing.

Read the job
curl --get "https://api.spicyapi.ai/api/v1/jobs/recordInfo" \
  --data-urlencode "taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Start polling at about 2 seconds and gradually increase the interval. Stop at a terminal state. After a connection failure, query the original taskId. Retry creation only with the original idempotency key and body.

Or let the callback find you
import { verifyWebhook } from "@spicyapi/sdk";

// express.raw keeps the bytes we signed; express.json never matches.
app.post("/hooks/spicy", express.raw({ type: "application/json" }), (req, res) => {
  const { payload } = verifyWebhook({
    rawBody: req.body,
    timestamp: req.header("X-Webhook-Timestamp"),
    signature: req.header("X-Webhook-Signature"),
    payloadVersion: Number(req.header("X-Webhook-Payload-Version")),
    secret: process.env.SPICY_WEBHOOK_SECRET,
  });
  res.status(200).end();
  void handleFinishedTask(payload);
});

Pass callBackUrl when you create the task and the finished record is POSTed to you — no polling loop at all. Every delivery carries X-Webhook-Timestamp, X-Webhook-Signature and X-Webhook-Payload-Version. The signature is a base64 HMAC-SHA256 over taskId.timestamp.sha256(body), so it must be checked against the raw bytes: parsing the JSON and re-serialising it changes them and the check will fail. Failed deliveries are retried, so the same taskId can arrive twice — make the handler idempotent. Answer 2xx first and do the work afterwards; a slow handler is treated as a failed delivery.

Read the result

Consume output only when state is succeeded. On failure, use errorCode, errorMessage and request_id to investigate. Example costs and states do not represent an actual bill.

Completed response example
{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_record",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "model": "spicyapi/face-swap-v1/edit",
    "state": "succeeded",
    "output": {
      "assets": [
        {
          "key": "tasks/2026/08/28/job_01k3m8x9q2z4v7n5p6r8s0t1w3/3f7a1c9e5b2d48f0a6c1e3d5b7f9a1c3.png",
          "mime": "image/png",
          "url": "https://example.r2.cloudflarestorage.com/results/job_01k3m8x9q2z4v7n5p6r8s0t1w3/result.png?X-Amz-Signature=SIGNATURE_FROM_RESPONSE",
          "expiresAt": "2026-08-28T12:20:08.000Z"
        }
      ]
    },
    "cost": "0.750000",
    "settled": true,
    "createdAt": "2026-08-28T12:00:00Z",
    "completedAt": "2026-08-28T12:00:30Z"
  }
}

For each available asset, open or download assets[].url directly without an API Authorization header. The signed URL expires at expiresAt; poll the task again to refresh it while the asset remains within its retention period. A pending or unavailable asset has no URL. Treat signed URLs as private.

SDKs & integrations

Use SpicyAPI in your app, terminal, AI assistant or visual workflow. Choose a setup guide below.

SDKs
TypeScript · Python · Go · PHP · Java
CLI
Terminal commands and automation scripts.
MCP
Claude Code · Cursor · Codex
Agent Skill
Reusable instructions for your AI assistant.
n8n
Self-hosted community nodes and importable HTTP Request templates for n8n Cloud.
ComfyUI
Image, video and audio workflows on a node canvas.

More integrations

SillyTavernTelegram / DiscordApp proxyOpenAI SDKLangChainVercel AI SDK
Browse ready-to-use workflows

Use it in ComfyUI

Install the SpicyAPI nodes from ComfyUI Manager or with the command below, then search for Face Swap · Image Editing on the canvas. The node has the same options as this page and shows its price before it runs.

cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapi
Workflow examplesSetup guideSource on GitHub