> ## Documentation Index > Fetch the complete documentation index at: https://docs.magichour.ai/llms.txt > Use this file to discover all available pages before exploring further. # Head Swap > Swap a head onto a body image. Each image costs 10 credits. Output resolution depends on your subscription; you may set `max_resolution` lower than your plan maximum if desired. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/head-swap openapi: 3.0.2 info: title: Magic Hour API version: beta description: > Magic Hour provides an API (beta) that can be integrated into your own application to generate videos and images using AI. Webhook documentation can be found [here](https://docs.magichour.ai/webhook-reference). If you have any questions, please reach out to us via [discord](https://discord.gg/JX5rgsZaJp). # Authentication Every request requires an API key. To get started, first generate your API key [here](https://magichour.ai/developer?tab=api-keys&utm_source=docs&utm_medium=referral&utm_campaign=api-reference). Then, add the `Authorization` header to the request. | Key | Value | |-|-| | Authorization | Bearer mhk_live_apikey | > **Warning**: any API call that renders a video will utilize credits in your account. termsOfService: https://magichour.ai/terms-of-service servers: - url: https://api.magichour.ai security: [] tags: - name: Files description: API related to uploading and reusing assets - name: Image Projects description: API related to image projects - name: Video Projects description: API related to video projects - name: Audio Projects description: API related to audio projects - name: Account description: API related to the account that owns the API key paths: /v1/head-swap: post: tags: - Image Projects summary: Head Swap description: >- Swap a head onto a body image. Each image costs 10 credits. Output resolution depends on your subscription; you may set `max_resolution` lower than your plan maximum if desired. operationId: headSwap.createImage parameters: [] requestBody: required: true description: Body content: application/json: schema: type: object properties: name: type: string description: Give your image a custom name for easy identification. example: My Head Swap image default: Head Swap - dateTime max_resolution: type: integer description: >- 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 assets: type: object properties: body_file_path: type: string minLength: 1 description: > Image that receives the swapped head. This value is either - a direct URL to the video file - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls). See the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details. example: api-assets/id/1234.png head_file_path: type: string minLength: 1 description: > Image of the head to place on the body. This value is either - a direct URL to the video file - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls). See the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details. example: api-assets/id/5678.png required: - body_file_path - head_file_path description: Provide the body and head images for head swap required: - assets responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string example: cuid-example description: >- Unique ID of the image. Use it with the [Get image Project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch status and downloads. credits_charged: type: integer description: >- 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 required: - id - credits_charged description: Success '400': description: Invalid Request content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - invalid_request description: >- Machine-readable error code. - `invalid_request`: Fix request syntax or validation errors before retrying. message: type: string description: Human-readable error message. '401': description: Unauthorized content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - unauthorized description: |- Machine-readable error code. - `unauthorized`: Provide a valid API key before retrying. message: type: string description: Human-readable error message. '402': description: Payment Required content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - insufficient_credits - subscription_required - plan_upgrade_required description: >- Machine-readable error code. - `insufficient_credits`: Purchase credits before retrying. - `subscription_required`: Start a subscription before retrying. - `plan_upgrade_required`: Upgrade the subscription plan before retrying. message: type: string description: Human-readable error message. '404': description: Not Found content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - not_found description: |- Machine-readable error code. - `not_found`: Check the route or resource identifier. message: type: string description: Human-readable error message. '422': description: Unprocessable Entity content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - unprocessable_entity description: >- Machine-readable error code. - `unprocessable_entity`: Change the request values before retrying. message: type: string description: Human-readable error message. '500': description: Internal Server Error content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - internal_server_error description: >- Machine-readable error code. - `internal_server_error`: Retry later or contact support if the error continues. message: type: string description: Human-readable error message. security: - bearerAuth: [] x-codeSamples: - lang: python source: |- 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=".", ) - lang: javascript source: |- import { Client } from "magic-hour"; const client = new Client({ token: process.env["API_TOKEN"]!! }); const res = await client.v1.headSwap.create({ assets: { bodyFilePath: "api-assets/id/1234.png", headFilePath: "api-assets/id/5678.png", }, maxResolution: 1024, name: "My Head Swap image", }); - lang: go source: "package main\n\nimport (\n\tos \"os\"\n\n\tsdk \"github.com/magichourhq/magic-hour-go/client\"\n\tnullable \"github.com/magichourhq/magic-hour-go/nullable\"\n\thead_swap \"github.com/magichourhq/magic-hour-go/resources/v1/head_swap\"\n\ttypes \"github.com/magichourhq/magic-hour-go/types\"\n)\n\nfunc main() {\n\tclient := sdk.NewClient(\n\t\tsdk.WithBearerAuth(os.Getenv(\"API_TOKEN\")),\n\t)\n\tres, err := client.V1.HeadSwap.Create(head_swap.CreateRequest{\n\t\tAssets: types.V1HeadSwapCreateBodyAssets{\n\t\t\tBodyFilePath: \"api-assets/id/1234.png\",\n\t\t\tHeadFilePath: \"api-assets/id/5678.png\",\n\t\t},\n\t\tMaxResolution: nullable.NewValue(1024),\n\t\tName: nullable.NewValue(\"My Head Swap image\"),\n\t})\n}" - lang: rust source: |- let client = magic_hour::Client::default() .with_bearer_auth(&std::env::var("API_TOKEN").unwrap()); let res = client .v1() .head_swap() .create(magic_hour::resources::v1::head_swap::CreateRequest { assets: magic_hour::models::V1HeadSwapCreateBodyAssets { body_file_path: "api-assets/id/1234.png".to_string(), head_file_path: "api-assets/id/5678.png".to_string(), }, max_resolution: Some(1024), name: Some("My Head Swap image".to_string()), }) .await; - lang: curl source: |- curl --request POST \ --url https://api.magichour.ai/v1/head-swap \ --header 'accept: application/json' \ --header 'authorization: Bearer ' \ --header 'content-type: application/json' \ --data ' { "name": "My Head Swap image", "max_resolution": 1024, "assets": { "body_file_path": "api-assets/id/1234.png", "head_file_path": "api-assets/id/5678.png" } } ' - lang: php source: |- "https://api.magichour.ai/v1/head-swap", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => json_encode([ 'name' => 'My Head Swap image', 'max_resolution' => 1024, 'assets' => [ 'body_file_path' => 'api-assets/id/1234.png', 'head_file_path' => 'api-assets/id/5678.png' ] ]), CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: Bearer ", "content-type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: java source: >- HttpResponse response = Unirest.post("https://api.magichour.ai/v1/head-swap") .header("accept", "application/json") .header("content-type", "application/json") .header("authorization", "Bearer ") .body("{\"name\":\"My Head Swap image\",\"max_resolution\":1024,\"assets\":{\"body_file_path\":\"api-assets/id/1234.png\",\"head_file_path\":\"api-assets/id/5678.png\"}}") .asString(); components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer authentication header of the form `Bearer `, where `` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys&utm_source=docs&utm_medium=referral&utm_campaign=api-reference) and click "Create new API Key". ````