Skip to main content
POST
/
v1
/
face-swap
Python
from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.face_swap.generate(
    assets={
        "face_mappings": [
            {
                "new_face": "/path/to/1234.png",
                "original_face": "api-assets/id/0-0.png",
            }
        ],
        "face_swap_mode": "all-faces",
        "image_file_path": "image/id/1234.png",
        "video_file_path": "/path/to/1234.mp4",
        "video_source": "file",
    },
    end_seconds=15.0,
    start_seconds=0.0,
    name="Face Swap video",
    style={"version": "default"},
    wait_for_completion=True,
    download_outputs=True,
    download_directory="outputs"
)
{
  "id": "cuid-example",
  "credits_charged": 450
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

​
start_seconds
number<float>
required

Start time of your clip (seconds). Must be ≥ 0.

Required range: x >= 0
Example:

0

​
end_seconds
number<float>
required

End time of your clip (seconds). Must be greater than start_seconds.

Required range: x >= 0.1
Example:

15

​
assets
object
required

Provide the assets for face swap. For video, The video_source field determines whether video_file_path or youtube_url field is used

​
name
string
default:Face Swap - dateTime

Give your video a custom name for easy identification.

Example:

"My Face Swap video"

​
style
object

Style of the face swap video.

Example:
{ "version": "default" }

Response

Success

Success

​
id
string
required

Unique ID of the video. Use it with the Get video Project API to fetch status and downloads.

Example:

"cuid-example"

​
credits_charged
integer
required

The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video.

If video generation fails, credits will be refunded, and this field will be updated to include the refund.

Example:

450