Actions26
- Account Actions
- Character Actions
- Folder Actions
- Image Actions
- Model Actions
- Tools Actions
Tools → Face Swap
AI-generatedSummary
Swap faces between a source face image and a target image via the Supermachine API, supporting local IDs or external URLs with configurable polling and folder storage.
Inputs
- faceImageSource — Where to get the face image from (the face you want to use). Options: Image ID or Image URL. Default: imageId.
- faceImageId (required) — The ID of the face image to use. Visible when faceImageSource is set to imageId.
- faceImageUrl (required) — The URL of the face image to use. Visible when faceImageSource is set to imageUrl.
- targetImageSource — Where to get the target image from (the image where face will be swapped). Options: Image ID or Image URL. Default: imageId.
- targetImageId (required) — The ID of the target image. Visible when targetImageSource is set to imageId.
- targetImageUrl (required) — The URL of the target image. Visible when targetImageSource is set to imageUrl.
- additionalOptions — Optional settings for folder storage and polling behavior. Contains folderId (options, loadFolders), skipPolling (boolean, default false), pollingInterval (number, default 2, visible when skipPolling is false), and maxPollingTime (number, default 120, visible when skipPolling is false).
Output shape
object
Returns a job result object. If skipPolling is true, returns immediately with batchId and status 'submitted'. If polling completes, returns status 'completed' with final image metadata. On timeout, throws an error. The response always includes batchId, success boolean, tool 'faceswap', creditsCost (default 2 if unspecified), and creditsRemaining. When completed, includes completedAt ISO datetime and merged result image metadata; when submitted, includes a descriptive message.
Examples
Example 1: Submit face swap job without polling
Set faceImageSource to 'imageId' with a valid faceImageId, targetImageSource to 'imageId' with a valid targetImageId, and set skipPolling to true in additionalOptions. The node returns immediately with a batchId and submitted status.
Example 2: Wait for face swap completion
Configure all image sources and IDs, leave skipPolling as false (default), and the node polls the Supermachine API every pollingInterval seconds (default 2) for up to maxPollingTime seconds (default 120) until the face swap finishes or fails.