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

client = Client(token=getenv("API_TOKEN"))
res = client.v1.head_swap.generate(
    assets={
        "body_file_path": "/path/to/body.png",
        "head_file_path": "/path/to/head.png",
    },
    max_resolution=1024,
    name="My Head Swap image",
    wait_for_completion=True,
    download_outputs=True,
    download_directory=".",
)
{
  "id": "cuid-example",
  "credits_charged": 10
}

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

​
assets
object
required

Provide the body and head images for head swap

​
name
string
default:Head Swap - dateTime

Give your image a custom name for easy identification.

Example:

"My Head Swap image"

​
max_resolution
integer

Constrains the larger dimension (height or width) of the output. Omit to use the maximum allowed for your plan (capped at 2048px). Values above your plan maximum are clamped down to your plan's maximum.

Example:

1024

Response

Success

Success

​
id
string
required

Unique ID of the image. Use it with the Get image 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 image. We charge credits right when the request is made.

If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.

Example:

10