> ## 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. # Face Swap Video API Reference - Magic Hour Docs > **What this API does** Create the same Face Swap you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow. **Good for** - Automation and batch processing - Adding face swap into apps, pipelines, or tools **How it works (3 steps)** 1) Upload your inputs (video, image, or audio) with [Generate Upload URLs](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls) and copy the `file_path`. 2) Send a request to create a face swap job with the basic fields. 3) Check the job status until it's `complete`, then download the result from `downloads`. **Key options** - Inputs: usually a file, sometimes a YouTube link, depending on project type - Resolution: free users are limited to 576px; higher plans unlock HD and larger sizes - Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt **Cost** Credits are only charged for the frames that actually render. You'll see an estimate when the job is queued, and the final total after it's done. For detailed examples, see the [product page](https://magichour.ai/products/face-swap). ## OpenAPI ````yaml post /v1/face-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://magichour.ai/docs/webhook). 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/settings/developer). 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 assets used for video generation - 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 paths: /v1/face-swap: post: tags: - Video Projects summary: Face Swap Video description: >- **What this API does** Create the same Face Swap you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow. **Good for** - Automation and batch processing - Adding face swap into apps, pipelines, or tools **How it works (3 steps)** 1) Upload your inputs (video, image, or audio) with [Generate Upload URLs](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls) and copy the `file_path`. 2) Send a request to create a face swap job with the basic fields. 3) Check the job status until it's `complete`, then download the result from `downloads`. **Key options** - Inputs: usually a file, sometimes a YouTube link, depending on project type - Resolution: free users are limited to 576px; higher plans unlock HD and larger sizes - Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt **Cost** Credits are only charged for the frames that actually render. You'll see an estimate when the job is queued, and the final total after it's done. For detailed examples, see the [product page](https://magichour.ai/products/face-swap). operationId: faceSwap.createVideo parameters: [] requestBody: required: true description: Body content: application/json: schema: type: object properties: name: type: string description: Give your video a custom name for easy identification. example: My Face Swap video default: Face Swap - dateTime start_seconds: type: number minimum: 0 description: Start time of your clip (seconds). Must be ≥ 0. format: float example: 0 end_seconds: type: number minimum: 0.1 description: >- End time of your clip (seconds). Must be greater than start_seconds. format: float example: 15 style: type: object properties: version: type: string enum: - v1 - v2 - default example: default description: >- * `v1` - May preserve skin detail and texture better, but weaker identity preservation. * `v2` - Faster, sharper, better handling of hair and glasses. stronger identity preservation. * `default` - Use the version we recommend, which will change over time. This is recommended unless you need a specific earlier version. This is the default behavior. description: Style of the face swap video. example: version: default assets: type: object properties: face_swap_mode: default: all-faces type: string enum: - all-faces - individual-faces description: >- Choose how to swap faces: **all-faces** (recommended) — swap all detected faces using one source image (`source_file_path` required) +- **individual-faces** — specify exact mappings using `face_mappings` example: all-faces image_file_path: type: string description: > The path of the input image with the face to be swapped. The value is required if `face_swap_mode` is `all-faces`. 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: image/id/1234.png face_mappings: type: array items: type: object properties: original_face: type: string description: >- The face detected from the image in `target_file_path`. The file name is in the format of `-.png`. This value is corresponds to the response in the [face detection API](https://docs.magichour.ai/api-reference/files/get-face-detection-details). * The face_frame is the frame number of the face in the target image. For images, the frame number is always 0. * The face_index is the index of the face in the target image, starting from 0 going left to right. example: api-assets/id/0-0.png new_face: type: string description: > The face image that will be used to replace the face in the `original_face`. 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 required: - original_face - new_face maxItems: 5 description: >- This is the array of face mappings used for multiple face swap. The value is required if `face_swap_mode` is `individual-faces`. example: - original_face: api-assets/id/0-0.png new_face: api-assets/id/1234.png video_source: type: string enum: - file - youtube description: Choose your video source. example: file video_file_path: type: string description: > Your video file. Required if `video_source` is `file`. 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.mp4 youtube_url: type: string format: uri description: YouTube URL (required if `video_source` is `youtube`). required: - video_source description: >- Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used required: - start_seconds - end_seconds - assets responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string example: cuid-example description: >- Unique ID of the video. Use it with the [Get video Project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch status and downloads. credits_charged: type: integer description: >- 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 required: - id - estimated_frame_cost - credits_charged description: Success '400': description: Invalid Request content: application/json: schema: type: object properties: message: type: string required: - message description: The request is invalid example: message: Missing request body '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string enum: - Unauthorized required: - message description: The request is not properly authenticated example: message: Unauthorized '402': description: Payment Required content: application/json: schema: type: object properties: message: type: string required: - message description: The request requires payment example: message: Payment required '404': description: Not Found content: application/json: schema: type: object properties: message: type: string enum: - Not Found required: - message description: Requested resource is not found example: message: Not Found '422': description: Unprocessable Entity content: application/json: schema: type: object properties: message: type: string example: Unable to create video required: - message description: Unprocessable Entity 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.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="." ) - lang: javascript source: |- import { Client } from "magic-hour"; const client = new Client({ token: process.env["API_TOKEN"]!! }); const res = await client.v1.faceSwap.generate( { assets: { faceMappings: [ { newFace: "api-assets/id/1234.png", originalFace: "api-assets/id/0-0.png", }, ], faceSwapMode: "all-faces", imageFilePath: "image/id/1234.png", videoFilePath: "/path/to/1234.mp4", videoSource: "file", }, endSeconds: 15.0, name: "Face Swap video", startSeconds: 0.0, style: { version: "default" }, }, { waitForCompletion: true, downloadOutputs: true, downloadDirectory: ".", }, ); - 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\tface_swap \"github.com/magichourhq/magic-hour-go/resources/v1/face_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.FaceSwap.Create(face_swap.CreateRequest{\n\t\tAssets: types.V1FaceSwapCreateBodyAssets{\n\t\t\tFaceMappings: nullable.NewValue([]types.V1FaceSwapCreateBodyAssetsFaceMappingsItem{\n\t\t\t\ttypes.V1FaceSwapCreateBodyAssetsFaceMappingsItem{\n\t\t\t\t\tNewFace: \"api-assets/id/1234.png\",\n\t\t\t\t\tOriginalFace: \"api-assets/id/0-0.png\",\n\t\t\t\t},\n\t\t\t}),\n\t\t\tFaceSwapMode: nullable.NewValue(types.V1FaceSwapCreateBodyAssetsFaceSwapModeEnumAllFaces),\n\t\t\tImageFilePath: nullable.NewValue(\"image/id/1234.png\"),\n\t\t\tVideoFilePath: nullable.NewValue(\"api-assets/id/1234.mp4\"),\n\t\t\tVideoSource: types.V1FaceSwapCreateBodyAssetsVideoSourceEnumFile,\n\t\t},\n\t\tEndSeconds: 15.0,\n\t\tName: nullable.NewValue(\"My Face Swap video\"),\n\t\tStartSeconds: 0.0,\n\t\tStyle: nullable.NewValue(types.V1FaceSwapCreateBodyStyle{\n\t\t\tVersion: nullable.NewValue(types.V1FaceSwapCreateBodyStyleVersionEnumDefault),\n\t\t}),\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() .face_swap() .create(magic_hour::resources::v1::face_swap::CreateRequest { assets: magic_hour::models::V1FaceSwapCreateBodyAssets { face_mappings: Some( vec![ magic_hour::models::V1FaceSwapCreateBodyAssetsFaceMappingsItem { new_face : "api-assets/id/1234.png".to_string(), original_face : "api-assets/id/0-0.png".to_string() } ], ), face_swap_mode: Some( magic_hour::models::V1FaceSwapCreateBodyAssetsFaceSwapModeEnum::AllFaces, ), image_file_path: Some("image/id/1234.png".to_string()), video_file_path: Some("api-assets/id/1234.mp4".to_string()), video_source: magic_hour::models::V1FaceSwapCreateBodyAssetsVideoSourceEnum::File, ..Default::default() }, end_seconds: 15.0, name: Some("My Face Swap video".to_string()), start_seconds: 0.0, style: Some(magic_hour::models::V1FaceSwapCreateBodyStyle { version: Some( magic_hour::models::V1FaceSwapCreateBodyStyleVersionEnum::Default, ), }), ..Default::default() }) .await; - lang: curl source: |- curl --request POST \ --url https://api.magichour.ai/v1/face-swap \ --header 'accept: application/json' \ --header 'authorization: Bearer ' \ --header 'content-type: application/json' \ --data ' { "name": "My Face Swap video", "start_seconds": 0, "end_seconds": 15, "style": { "version": "default" }, "assets": { "face_swap_mode": "all-faces", "image_file_path": "image/id/1234.png", "face_mappings": [ { "original_face": "api-assets/id/0-0.png", "new_face": "api-assets/id/1234.png" } ], "video_source": "file", "video_file_path": "api-assets/id/1234.mp4", "youtube_url": "string" } } ' - lang: php source: |- "https://api.magichour.ai/v1/face-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 Face Swap video', 'start_seconds' => 0, 'end_seconds' => 15, 'style' => [ 'version' => 'default' ], 'assets' => [ 'face_swap_mode' => 'all-faces', 'image_file_path' => 'image/id/1234.png', 'face_mappings' => [ [ 'original_face' => 'api-assets/id/0-0.png', 'new_face' => 'api-assets/id/1234.png' ] ], 'video_source' => 'file', 'video_file_path' => 'api-assets/id/1234.mp4', 'youtube_url' => 'string' ] ]), 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/face-swap") .header("accept", "application/json") .header("content-type", "application/json") .header("authorization", "Bearer ") .body("{\"name\":\"My Face Swap video\",\"start_seconds\":0,\"end_seconds\":15,\"style\":{\"version\":\"default\"},\"assets\":{\"face_swap_mode\":\"all-faces\",\"image_file_path\":\"image/id/1234.png\",\"face_mappings\":[{\"original_face\":\"api-assets/id/0-0.png\",\"new_face\":\"api-assets/id/1234.png\"}],\"video_source\":\"file\",\"video_file_path\":\"api-assets/id/1234.mp4\",\"youtube_url\":\"string\"}}") .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) and click "Create new API Key". ````