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)
Upload your inputs (video, image, or audio) with Generate Upload URLs and copy the file_path.
Send a request to create a face swap job with the basic fields.
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: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.
Extra fields: e.g. face_swap_mode, start_seconds/end_seconds, or a text prompt
Cost
Credits are charged when the job is queued (credits_charged in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.
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".
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Magic Hour API Docs","description":"Easily generate videos, images, and audio using Magic Hour's API. Follow our documentation to seamlessly integrate AI content creation into your applications.","colors":{"primary":"#3b82f6","light":"#0564ff","dark":"#3b82f6"},"logo":{"light":"https://mintcdn.com/magichour/5sgGJpuuipkw5s5v/icons/logo-light.svg?fit=max\u0026auto=format\u0026n=5sgGJpuuipkw5s5v\u0026q=85\u0026s=1f167e30baf11927bc2e0932411e455b","dark":"https://mintcdn.com/magichour/5sgGJpuuipkw5s5v/icons/logo-dark.svg?fit=max\u0026auto=format\u0026n=5sgGJpuuipkw5s5v\u0026q=85\u0026s=15c8bda28931ac4e1e2fab2c0ba6f0d5"},"favicon":"https://mintcdn.com/magichour/kbUwXh9ksnVyRSci/icons/favicon.png?fit=max\u0026auto=format\u0026n=kbUwXh9ksnVyRSci\u0026q=85\u0026s=c4fda903b24dd7067dadd1bb75508987","appearance":{"default":"dark","strict":false},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:support@magichour.ai","label":"Support"}],"primary":{"type":"button","label":"Get API key","href":"https://magichour.ai/developer?tab=api-keys\u0026ref=docs-navbar\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=navbar"}},"footer":{"socials":{"website":"https://magichour.ai/?utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=footer","x":"https://x.com/magichourai","github":"https://github.com/magichourhq","linkedin":"https://linkedin.com/company/magichour","instagram":"https://instagram.com/magichourai","youtube":"https://youtube.com/@magichourai"}},"seo":{"metatags":{"og:image":"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg","twitter:image":"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg"}},"integrations":{"ga4":{"measurementId":"G-CZ9Q9NBZB3"},"posthog":{"apiKey":"phc_EmzSy2RU0TOPhpouazMzxFedNdMyhze8HakyjffW2Wr","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["chatgpt","claude","perplexity","mcp","cursor","vscode","copy","view"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"API quickstart","icon":"forward-fast","href":"/get-started/quick-start"},{"anchor":"API pricing","icon":"credit-card","href":"/billing/overview"},{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/JX5rgsZaJp"},{"anchor":"Status","icon":"wave-pulse","href":"https://status.magichour.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"magichour","hasAudioNarration":false,"actualSubdomain":"magichour","customDomains":["docs.magichour.ai"],"gitSource":{"type":"github","owner":"magichourhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae36fc26dca5a83b8f3aeca","collectionId":"b8b7d9ef-9046-4620-ba2f-41ff567b76bf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae36fc26dca5a83b8f3aeca"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae36fc26dca5a83b8f3aeca","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Documentation","count":97},{"language":"default","tag":"Integration","count":56},{"language":"default","tag":"API Reference","count":45},{"language":"default","tag":"Tools","count":30},{"language":"default","tag":"Image Projects","count":16},{"language":"default","tag":"Video Projects","count":16},{"language":"default","tag":"Images","count":15},{"language":"default","tag":"Video","count":12},{"language":"default","tag":"Webhook Reference","count":10},{"language":"default","tag":"Get Started","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar,#table-of-contents-content{scrollbar-width:thin;scrollbar-gutter:none;scrollbar-color:gray transparent}"}],"page":{"pagePath":"api-reference/video-projects/face-swap-video","slug":"/api-reference/video-projects/face-swap-video","pageMetadata":{"openapi":"post /v1/face-swap","title":"Face Swap Video API Reference - Magic Hour Docs","sidebarTitle":"Face Swap Video","description":"**What this API does**\n\nCreate 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.\n \n**Good for**\n- Automation and batch processing \n- Adding face swap into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) 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`. \n2) Send a request to create a face swap job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/face-swap).","href":"/api-reference/video-projects/face-swap-video"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n br: \"br\",\n code: \"code\",\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"What this API does\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"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.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Good for\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Automation and batch processing\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Adding face swap into apps, pipelines, or tools\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"How it works (3 steps)\"\n })\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Upload your inputs (video, image, or audio) with \", _jsx(_components.a, {\n href: \"https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls\",\n children: \"Generate Upload URLs\"\n }), \" and copy the \", _jsx(_components.code, {\n children: \"file_path\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Send a request to create a face swap job with the basic fields.\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Check the job status until it’s \", _jsx(_components.code, {\n children: \"complete\"\n }), \", then download the result from \", _jsx(_components.code, {\n children: \"downloads\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Key options\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Inputs: usually a file, sometimes a YouTube link, depending on project type\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Extra fields: e.g. \", _jsx(_components.code, {\n children: \"face_swap_mode\"\n }), \", \", _jsx(_components.code, {\n children: \"start_seconds\"\n }), \"/\", _jsx(_components.code, {\n children: \"end_seconds\"\n }), \", or a text prompt\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Cost\"\n }), _jsx(_components.br, {}), \"\\n\", \"Credits are charged when the job is queued (\", _jsx(_components.code, {\n children: \"credits_charged\"\n }), \" in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For detailed examples, see the \", _jsx(_components.a, {\n href: \"https://magichour.ai/products/face-swap\",\n children: \"product page\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v1/face-swap","title":"Face Swap Video API Reference - Magic Hour Docs","sidebarTitle":"Face Swap Video","description":"**What this API does**\n\nCreate 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.\n \n**Good for**\n- Automation and batch processing \n- Adding face swap into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) 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`. \n2) Send a request to create a face swap job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/face-swap).","href":"/api-reference/video-projects/face-swap-video"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"**What this API does**\n\nCreate 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.\n \n**Good for**\n- Automation and batch processing \n- Adding face swap into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) 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`. \n2) Send a request to create a face swap job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/face-swap).","summary":"Face Swap Video","tags":["Video Projects"],"parameters":[],"operationId":"faceSwap.createVideo","requestBody":"66e47218-5aa6-4014-b596-f2fa5ad64f08","responses":{"200":"4264ffdf-e96d-4aef-83a6-6408d1477001","400":"a3a820ae-fa44-4dce-964a-47610630acde","401":"3227bcc3-ae83-4ce5-963a-f72de52b8803","402":"b1cb2b37-875c-4109-89b7-afffb355a774","404":"b46ceea3-daf3-4ba1-b58d-c3a593282dee","422":"b922da15-c316-47e2-86d7-c95bcfdde346","500":"fa5b3393-bc9c-4177-aa0e-b88c8baf61f0"},"security":["76c59c5c-eac2-4032-9680-88b57775d439"],"x-codeSamples":[{"lang":"python","source":"from magic_hour import Client\nfrom os import getenv\n\nclient = Client(token=getenv(\"MAGIC_HOUR_API_KEY\"))\nres = client.v1.face_swap.generate(\n assets={\n \"face_swap_mode\": \"all-faces\",\n \"image_file_path\": \"image/id/1234.png\",\n \"video_file_path\": \"/path/to/1234.mp4\",\n \"video_source\": \"file\",\n },\n end_seconds=15.0,\n start_seconds=0.0,\n name=\"Face Swap video\",\n style={\"version\": \"default\"},\n wait_for_completion=True,\n download_outputs=True,\n download_directory=\".\"\n)"},{"lang":"javascript","source":"import { Client } from \"magic-hour\";\n\nconst client = new Client({ token: process.env[\"MAGIC_HOUR_API_KEY\"] });\nconst res = await client.v1.faceSwap.generate(\n {\n assets: {\n faceSwapMode: \"all-faces\",\n imageFilePath: \"image/id/1234.png\",\n videoFilePath: \"/path/to/1234.mp4\",\n videoSource: \"file\",\n },\n endSeconds: 15.0,\n name: \"Face Swap video\",\n startSeconds: 0.0,\n style: { version: \"default\" },\n },\n {\n waitForCompletion: true,\n downloadOutputs: true,\n downloadDirectory: \".\",\n },\n);"},{"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(\"MAGIC_HOUR_API_KEY\")),\n\t)\n\tres, err := client.V1.FaceSwap.Create(face_swap.CreateRequest{\n\t\tAssets: types.V1FaceSwapCreateBodyAssets{\n\t\t\tFaceSwapMode: nullable.NewValue(types.V1FaceSwapCreateBodyAssetsFaceSwapModeEnumAllFaces),\n\t\t\tImageFilePath: nullable.NewValue(\"api-assets/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: 5.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()\n .with_bearer_auth(\u0026std::env::var(\"MAGIC_HOUR_API_KEY\").unwrap());\nlet res = client\n .v1()\n .face_swap()\n .create(magic_hour::resources::v1::face_swap::CreateRequest {\n assets: magic_hour::models::V1FaceSwapCreateBodyAssets {\n face_swap_mode: Some(\n magic_hour::models::V1FaceSwapCreateBodyAssetsFaceSwapModeEnum::AllFaces,\n ),\n image_file_path: Some(\"api-assets/id/1234.png\".to_string()),\n video_file_path: Some(\"api-assets/id/1234.mp4\".to_string()),\n video_source: magic_hour::models::V1FaceSwapCreateBodyAssetsVideoSourceEnum::File,\n ..Default::default()\n },\n end_seconds: 5.0,\n name: Some(\"My Face Swap video\".to_string()),\n start_seconds: 0.0,\n style: Some(magic_hour::models::V1FaceSwapCreateBodyStyle {\n version: Some(\n magic_hour::models::V1FaceSwapCreateBodyStyleVersionEnum::Default,\n ),\n }),\n ..Default::default()\n })\n .await;"},{"lang":"curl","source":"curl --request POST \\\n --url https://api.magichour.ai/v1/face-swap \\\n --header 'accept: application/json' \\\n --header \"authorization: Bearer $MAGIC_HOUR_API_KEY\" \\\n --header 'content-type: application/json' \\\n --data '\n{\n \"name\": \"My Face Swap video\",\n \"start_seconds\": 0,\n \"end_seconds\": 5,\n \"style\": {\n \"version\": \"default\"\n },\n \"assets\": {\n \"face_swap_mode\": \"all-faces\",\n \"image_file_path\": \"api-assets/id/1234.png\",\n \"video_source\": \"file\",\n \"video_file_path\": \"api-assets/id/1234.mp4\"\n }\n}\n'"},{"lang":"php","source":"\u003c?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.magichour.ai/v1/face-swap\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'name' => 'My Face Swap video',\n 'start_seconds' => 0,\n 'end_seconds' => 5,\n 'style' => [\n 'version' => 'default'\n ],\n 'assets' => [\n 'face_swap_mode' => 'all-faces',\n 'image_file_path' => 'api-assets/id/1234.png',\n 'video_source' => 'file',\n 'video_file_path' => 'api-assets/id/1234.mp4'\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"accept: application/json\",\n \"authorization: Bearer \u003ctoken>\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"java","source":"HttpResponse\u003cString> response = Unirest.post(\"https://api.magichour.ai/v1/face-swap\")\n .header(\"accept\", \"application/json\")\n .header(\"content-type\", \"application/json\")\n .header(\"authorization\", \"Bearer \u003ctoken>\")\n .body(\"{\\\"name\\\":\\\"My Face Swap video\\\",\\\"start_seconds\\\":0,\\\"end_seconds\\\":5,\\\"style\\\":{\\\"version\\\":\\\"default\\\"},\\\"assets\\\":{\\\"face_swap_mode\\\":\\\"all-faces\\\",\\\"image_file_path\\\":\\\"api-assets/id/1234.png\\\",\\\"video_source\\\":\\\"file\\\",\\\"video_file_path\\\":\\\"api-assets/id/1234.mp4\\\"}}\")\n .asString();"}],"method":"post","type":"path","servers":["9d7d9813-e8f8-4d8d-bab1-aec4a4bedf19"],"path":"/v1/face-swap","baseUrlOptions":["https://api.magichour.ai"],"title":"Face Swap Video","codeSamples":[{"lang":"python","source":"from magic_hour import Client\nfrom os import getenv\n\nclient = Client(token=getenv(\"MAGIC_HOUR_API_KEY\"))\nres = client.v1.face_swap.generate(\n assets={\n \"face_swap_mode\": \"all-faces\",\n \"image_file_path\": \"image/id/1234.png\",\n \"video_file_path\": \"/path/to/1234.mp4\",\n \"video_source\": \"file\",\n },\n end_seconds=15.0,\n start_seconds=0.0,\n name=\"Face Swap video\",\n style={\"version\": \"default\"},\n wait_for_completion=True,\n download_outputs=True,\n download_directory=\".\"\n)"},{"lang":"javascript","source":"import { Client } from \"magic-hour\";\n\nconst client = new Client({ token: process.env[\"MAGIC_HOUR_API_KEY\"] });\nconst res = await client.v1.faceSwap.generate(\n {\n assets: {\n faceSwapMode: \"all-faces\",\n imageFilePath: \"image/id/1234.png\",\n videoFilePath: \"/path/to/1234.mp4\",\n videoSource: \"file\",\n },\n endSeconds: 15.0,\n name: \"Face Swap video\",\n startSeconds: 0.0,\n style: { version: \"default\" },\n },\n {\n waitForCompletion: true,\n downloadOutputs: true,\n downloadDirectory: \".\",\n },\n);"},{"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(\"MAGIC_HOUR_API_KEY\")),\n\t)\n\tres, err := client.V1.FaceSwap.Create(face_swap.CreateRequest{\n\t\tAssets: types.V1FaceSwapCreateBodyAssets{\n\t\t\tFaceSwapMode: nullable.NewValue(types.V1FaceSwapCreateBodyAssetsFaceSwapModeEnumAllFaces),\n\t\t\tImageFilePath: nullable.NewValue(\"api-assets/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: 5.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()\n .with_bearer_auth(\u0026std::env::var(\"MAGIC_HOUR_API_KEY\").unwrap());\nlet res = client\n .v1()\n .face_swap()\n .create(magic_hour::resources::v1::face_swap::CreateRequest {\n assets: magic_hour::models::V1FaceSwapCreateBodyAssets {\n face_swap_mode: Some(\n magic_hour::models::V1FaceSwapCreateBodyAssetsFaceSwapModeEnum::AllFaces,\n ),\n image_file_path: Some(\"api-assets/id/1234.png\".to_string()),\n video_file_path: Some(\"api-assets/id/1234.mp4\".to_string()),\n video_source: magic_hour::models::V1FaceSwapCreateBodyAssetsVideoSourceEnum::File,\n ..Default::default()\n },\n end_seconds: 5.0,\n name: Some(\"My Face Swap video\".to_string()),\n start_seconds: 0.0,\n style: Some(magic_hour::models::V1FaceSwapCreateBodyStyle {\n version: Some(\n magic_hour::models::V1FaceSwapCreateBodyStyleVersionEnum::Default,\n ),\n }),\n ..Default::default()\n })\n .await;"},{"lang":"curl","source":"curl --request POST \\\n --url https://api.magichour.ai/v1/face-swap \\\n --header 'accept: application/json' \\\n --header \"authorization: Bearer $MAGIC_HOUR_API_KEY\" \\\n --header 'content-type: application/json' \\\n --data '\n{\n \"name\": \"My Face Swap video\",\n \"start_seconds\": 0,\n \"end_seconds\": 5,\n \"style\": {\n \"version\": \"default\"\n },\n \"assets\": {\n \"face_swap_mode\": \"all-faces\",\n \"image_file_path\": \"api-assets/id/1234.png\",\n \"video_source\": \"file\",\n \"video_file_path\": \"api-assets/id/1234.mp4\"\n }\n}\n'"},{"lang":"php","source":"\u003c?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.magichour.ai/v1/face-swap\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'name' => 'My Face Swap video',\n 'start_seconds' => 0,\n 'end_seconds' => 5,\n 'style' => [\n 'version' => 'default'\n ],\n 'assets' => [\n 'face_swap_mode' => 'all-faces',\n 'image_file_path' => 'api-assets/id/1234.png',\n 'video_source' => 'file',\n 'video_file_path' => 'api-assets/id/1234.mp4'\n ]\n ]),\n CURLOPT_HTTPHEADER => [\n \"accept: application/json\",\n \"authorization: Bearer \u003ctoken>\",\n \"content-type: application/json\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"},{"lang":"java","source":"HttpResponse\u003cString> response = Unirest.post(\"https://api.magichour.ai/v1/face-swap\")\n .header(\"accept\", \"application/json\")\n .header(\"content-type\", \"application/json\")\n .header(\"authorization\", \"Bearer \u003ctoken>\")\n .body(\"{\\\"name\\\":\\\"My Face Swap video\\\",\\\"start_seconds\\\":0,\\\"end_seconds\\\":5,\\\"style\\\":{\\\"version\\\":\\\"default\\\"},\\\"assets\\\":{\\\"face_swap_mode\\\":\\\"all-faces\\\",\\\"image_file_path\\\":\\\"api-assets/id/1234.png\\\",\\\"video_source\\\":\\\"file\\\",\\\"video_file_path\\\":\\\"api-assets/id/1234.mp4\\\"}}\")\n .asString();"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"start_seconds":{"type":"number","minimum":0,"description":"Start time of your clip (seconds). Must be ≥ 0.","format":"float","example":0,"isRequired":true,"uniqueKey":"start_seconds","typeLabel":"number\u003cfloat>"},"end_seconds":{"type":"number","minimum":0.1,"description":"End time of your clip (seconds). Must be greater than start_seconds.","format":"float","example":5,"isRequired":true,"uniqueKey":"end_seconds","typeLabel":"number\u003cfloat>"},"assets":{"type":"object","properties":{"video_source":{"type":"string","enum":["file","youtube"],"description":"Choose your video source.","example":"file","isRequired":true,"uniqueKey":"assets.video_source","typeLabel":"enum\u003cstring>"},"face_swap_mode":{"default":"all-faces","type":"string","enum":["all-faces","individual-faces"],"description":"Choose how to swap faces:\n- **all-faces** (recommended) — swap all detected faces using one source image (`source_file_path` required)\n- **individual-faces** — specify exact mappings using `face_mappings`","example":"all-faces","uniqueKey":"assets.face_swap_mode","typeLabel":"enum\u003cstring>"},"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`.\n\nThis value is either\n- a direct URL to the file. The URL path must end in a supported file extension.\n- `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).\n\nSee the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details.\n","example":"api-assets/id/1234.png","uniqueKey":"assets.image_file_path","typeLabel":"string"},"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 `\u003cface_frame>-\u003cface_index>.png`. This value is corresponds to the response in the [face detection API](https://docs.magichour.ai/api-reference/files/get-face-detection-details).\n\n* The face_frame is the frame number of the face in the target image. For images, the frame number is always 0.\n* 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","isRequired":true,"uniqueKey":"assets.face_mappings.items.[INDEX].original_face","typeLabel":"string"},"new_face":{"type":"string","description":"The face image that will be used to replace the face in the `original_face`. This value is either\n- a direct URL to the file. The URL path must end in a supported file extension.\n- `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).\n\nSee the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details.\n","example":"api-assets/id/1234.png","isRequired":true,"uniqueKey":"assets.face_mappings.items.[INDEX].new_face","typeLabel":"string"}},"required":["original_face","new_face"],"uniqueKey":"assets.face_mappings.items.[INDEX]","typeLabel":"object"},"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"}],"uniqueKey":"assets.face_mappings","typeLabel":"object[]"},"video_file_path":{"type":"string","description":"Your video file. Required if `video_source` is `file`. This value is either\n- a direct URL to the file. The URL path must end in a supported file extension.\n- `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).\n\nSee the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details.\n","example":"api-assets/id/1234.mp4","uniqueKey":"assets.video_file_path","typeLabel":"string"},"youtube_url":{"type":"string","format":"uri","description":"YouTube URL (required if `video_source` is `youtube`).","uniqueKey":"assets.youtube_url","typeLabel":"string\u003curi>"}},"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","example":{"face_swap_mode":"all-faces","image_file_path":"api-assets/id/1234.png","video_source":"file","video_file_path":"api-assets/id/1234.mp4"},"isRequired":true,"uniqueKey":"assets","typeLabel":"object"},"name":{"type":"string","description":"Give your video a custom name for easy identification.","example":"My Face Swap video","default":"Face Swap - dateTime","uniqueKey":"name","typeLabel":"string"},"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.\n* `v2` - Faster, sharper, better handling of hair and glasses. stronger identity preservation.\n* `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.","uniqueKey":"style.version","typeLabel":"enum\u003cstring>"}},"description":"Style of the face swap video.","example":{"version":"default"},"uniqueKey":"style","typeLabel":"object"}},"required":["start_seconds","end_seconds","assets"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"start_seconds":0,"end_seconds":5,"assets":{"face_swap_mode":"all-faces","image_file_path":"api-assets/id/1234.png","video_source":"file","video_file_path":"api-assets/id/1234.mp4"},"name":"My Face Swap video","style":{"version":"default"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4264ffdf-e96d-4aef-83a6-6408d1477001":{"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.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"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. \n\nIf video generation fails, credits will be refunded, and this field will be updated to include the refund.","example":450,"isRequired":true,"uniqueKey":"credits_charged","typeLabel":"integer"}},"required":["id","credits_charged"],"description":"Success","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cuid-example","credits_charged":450}}},"exampleType":"generated"}},"exampleType":"generated"},"a3a820ae-fa44-4dce-964a-47610630acde":{"description":"Invalid Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request"],"description":"Machine-readable error code.\n\n- `invalid_request`: Fix request syntax or validation errors before retrying.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"invalid_request","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3227bcc3-ae83-4ce5-963a-f72de52b8803":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["unauthorized"],"description":"Machine-readable error code.\n\n- `unauthorized`: Provide a valid API key before retrying.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"unauthorized","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b1cb2b37-875c-4109-89b7-afffb355a774":{"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.\n\n- `insufficient_credits`: Purchase credits before retrying.\n\n- `subscription_required`: Start a subscription before retrying.\n\n- `plan_upgrade_required`: Upgrade the subscription plan before retrying.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"insufficient_credits","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b46ceea3-daf3-4ba1-b58d-c3a593282dee":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["not_found"],"description":"Machine-readable error code.\n\n- `not_found`: Check the route or resource identifier.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"not_found","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b922da15-c316-47e2-86d7-c95bcfdde346":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["unprocessable_entity"],"description":"Machine-readable error code.\n\n- `unprocessable_entity`: Change the request values before retrying.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"unprocessable_entity","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fa5b3393-bc9c-4177-aa0e-b88c8baf61f0":{"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.\n\n- `internal_server_error`: Retry later or contact support if the error continues.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"internal_server_error","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"76c59c5c-eac2-4032-9680-88b57775d439":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003capi_key>`, where `\u003capi_key>` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=api-reference) and click \"Create new API Key\".","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"9d7d9813-e8f8-4d8d-bab1-aec4a4bedf19":{"url":"https://api.magichour.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003capi_key>`, where `\u003capi_key>` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=api-reference) and click \"Create new API Key\".","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003capi_key>`, where `\u003capi_key>` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys\u0026utm_source=docs\u0026utm_medium=referral\u0026utm_campaign=api-reference) and click \"Create new API Key\".","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"magichour","siteName":"Magic Hour API Docs","title":"Face Swap Video API Reference - Magic Hour Docs - Magic Hour API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T16:10:45.579Z","originalFileLocation":"api-reference/video-projects/face-swap-video.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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 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\u0026#x27;s complete, then download the result from downloads. Key options - Inputs: usually a file, sometimes a YouTube link, depending on project type - Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video. - Extra fields: e.g. face_swap_mode, start_seconds/end_seconds, or a text prompt Cost Credits are charged when the job is queued (credits_charged in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded. For detailed examples, see the product page.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Magic Hour API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Face Swap Video API Reference - Magic Hour Docs - Magic Hour API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"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 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\u0026#x27;s complete, then download the result from downloads. Key options - Inputs: usually a file, sometimes a YouTube link, depending on project type - Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video. - Extra fields: e.g. face_swap_mode, start_seconds/end_seconds, or a text prompt Cost Credits are charged when the job is queued (credits_charged in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded. For detailed examples, see the product page.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Magic Hour API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Face Swap Video API Reference - Magic Hour Docs - Magic Hour API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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 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\u0026#x27;s complete, then download the result from downloads. Key options - Inputs: usually a file, sometimes a YouTube link, depending on project type - Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video. - Extra fields: e.g. face_swap_mode, start_seconds/end_seconds, or a text prompt Cost Credits are charged when the job is queued (credits_charged in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded. For detailed examples, see the product page.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/magichour/pV2W72GIHTaiOFzk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Magic Hour API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/video-projects/face-swap-video.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.magichour.ai/#organization\",\"name\":\"Magic Hour API Docs\",\"url\":\"https://docs.magichour.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/magichour/5sgGJpuuipkw5s5v/icons/logo-light.svg?fit=max\u0026auto=format\u0026n=5sgGJpuuipkw5s5v\u0026q=85\u0026s=1f167e30baf11927bc2e0932411e455b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.magichour.ai#website\",\"name\":\"Magic Hour API Docs\",\"url\":\"https://docs.magichour.ai\",\"publisher\":{\"@id\":\"https://docs.magichour.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video#webpage\",\"url\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video\",\"name\":\"Face Swap Video API Reference - Magic Hour Docs\",\"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 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: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video. - Extra fields: e.g. face_swap_mode, start_seconds/end_seconds, or a text prompt Cost Credits are charged when the job is queued (credits_charged in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded. For detailed examples, see the product page.\",\"dateModified\":\"2026-10-29T16:10:45.579Z\",\"isPartOf\":{\"@id\":\"https://docs.magichour.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Video Projects\",\"item\":\"https://docs.magichour.ai/api-reference/video-projects/get-video-details\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Face Swap Video API Reference - Magic Hour Docs\",\"item\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video#apireference\",\"headline\":\"Face Swap Video API Reference - Magic Hour Docs\",\"name\":\"Face Swap Video API Reference - Magic Hour Docs\",\"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 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: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video. - Extra fields: e.g. face_swap_mode, start_seconds/end_seconds, or a text prompt Cost Credits are charged when the job is queued (credits_charged in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded. For detailed examples, see the product page.\",\"url\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video\",\"mainEntityOfPage\":{\"@id\":\"https://docs.magichour.ai/api-reference/video-projects/face-swap-video#webpage\"},\"image\":\"https://d28dkohlqf5vwj.cloudfront.net/open-graph/logo-social-noisy-spectrum.jpg\",\"dateModified\":\"2026-10-29T16:10:45.579Z\",\"publisher\":{\"@id\":\"https://docs.magichour.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.magichour.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Magic Hour API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Magic Hour API Docs","nav":{"global":{"anchors":[{"anchor":"API quickstart","icon":"forward-fast","href":"/get-started/quick-start"},{"anchor":"API pricing","icon":"credit-card","href":"/billing/overview"},{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/JX5rgsZaJp"},{"anchor":"Status","icon":"wave-pulse","href":"https://status.magichour.ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"Models and Credit Costs","sidebarTitle":"Models","href":"/api-reference/models"},{"title":"Historical API Processing Times","sidebarTitle":"Processing Times","href":"/api-reference/processing-times"},{"group":"Account","pages":[{"openapi":"get /v1/account","title":"Get account details","href":"/api-reference/account/get-account-details"}]},{"group":"Files","pages":[{"openapi":"get /v1/saved-items","title":"List saved items","href":"/api-reference/files/list-saved-items"},{"openapi":"post /v1/files/upload-urls","title":"Generate Asset Upload Urls API Reference - Magic Hour Docs","sidebarTitle":"Generate Asset Upload Urls","href":"/api-reference/files/generate-asset-upload-urls"},{"openapi":"get /v1/face-detection/{id}","title":"Get Face Detection Details API Reference - Magic Hour Docs","sidebarTitle":"Get Face Detection Details","href":"/api-reference/files/get-face-detection-details"},{"openapi":"post /v1/face-detection","title":"Face Detection API Reference - Magic Hour Docs","sidebarTitle":"Face Detection","href":"/api-reference/files/face-detection"}]},{"group":"Video Projects","pages":[{"openapi":"get /v1/video-projects/{id}","title":"Get Video Details API Reference - Magic Hour Docs","sidebarTitle":"Get Video Details","href":"/api-reference/video-projects/get-video-details"},{"openapi":"delete /v1/video-projects/{id}","title":"Delete Video API Reference - Magic Hour Docs","sidebarTitle":"Delete Video","href":"/api-reference/video-projects/delete-video"},{"openapi":"post /v1/ai-talking-photo","title":"AI Talking Photo API Reference - Magic Hour Docs","sidebarTitle":"AI Talking Photo","href":"/api-reference/video-projects/ai-talking-photo"},{"openapi":"post /v1/ai-ugc-ad","title":"AI UGC Ad Generator","href":"/api-reference/video-projects/ai-ugc-ad-generator"},{"openapi":"post /v1/ai-video-editor","title":"AI Video Editor","href":"/api-reference/video-projects/ai-video-editor"},{"openapi":"post /v1/ai-video-translator","title":"AI Video Translator","href":"/api-reference/video-projects/ai-video-translator"},{"openapi":"post /v1/ai-video-upscaler","title":"AI Video Upscaler","href":"/api-reference/video-projects/ai-video-upscaler"},{"openapi":"post /v1/animation","title":"Animation API Reference - Magic Hour Docs","sidebarTitle":"Animation","href":"/api-reference/video-projects/animation"},{"openapi":"post /v1/audio-to-video","title":"Audio-to-Video","href":"/api-reference/video-projects/audio-to-video"},{"openapi":"post /v1/auto-subtitle-generator","title":"Auto Subtitle Generator API Reference - Magic Hour Docs","sidebarTitle":"Auto Subtitle Generator","href":"/api-reference/video-projects/auto-subtitle-generator"},{"openapi":"post /v1/character-replace","title":"Character Replace API Reference - Magic Hour Docs","sidebarTitle":"Character Replace","description":"**What this API does**\n\nCreate the same Character Replace 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.\n \n**Good for**\n- Automation and batch processing \n- Adding character replace into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) 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`. \n2) Send a request to create a character replace job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/character-replace).","href":"/api-reference/video-projects/character-replace"},{"openapi":"post /v1/face-swap","title":"Face Swap Video API Reference - Magic Hour Docs","sidebarTitle":"Face Swap Video","href":"/api-reference/video-projects/face-swap-video"},{"openapi":"post /v1/image-to-video","title":"Image-to-Video API Reference - Magic Hour Docs","sidebarTitle":"Image-to-Video","description":"**What this API does**\n\nCreate the same Image To Video 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.\n \n**Good for**\n- Automation and batch processing \n- Adding image to video into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) 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`. \n2) Send a request to create a image to video job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/image-to-video).","href":"/api-reference/video-projects/image-to-video"},{"openapi":"post /v1/lip-sync","title":"Lip Sync API Reference - Magic Hour Docs","sidebarTitle":"Lip Sync","href":"/api-reference/video-projects/lip-sync"},{"openapi":"post /v1/text-to-video","title":"Text-to-Video API Reference - Magic Hour Docs","sidebarTitle":"Text-to-Video","href":"/api-reference/video-projects/text-to-video"},{"openapi":"post /v1/video-to-video","title":"Video-to-Video API Reference - Magic Hour Docs","sidebarTitle":"Video-to-Video","href":"/api-reference/video-projects/video-to-video"}]},{"group":"Image Projects","pages":[{"openapi":"get /v1/image-projects/{id}","title":"Get Image Details API Reference - Magic Hour Docs","sidebarTitle":"Get Image Details","href":"/api-reference/image-projects/get-image-details"},{"openapi":"delete /v1/image-projects/{id}","title":"Delete Image API Reference - Magic Hour Docs","sidebarTitle":"Delete Image","href":"/api-reference/image-projects/delete-image"},{"openapi":"post /v1/ai-clothes-changer","title":"AI Clothes Changer API Reference - Magic Hour Docs","sidebarTitle":"AI Clothes Changer","href":"/api-reference/image-projects/ai-clothes-changer"},{"openapi":"post /v1/ai-face-editor","title":"AI Face Editor API Reference - Magic Hour Docs","sidebarTitle":"AI Face Editor","href":"/api-reference/image-projects/ai-face-editor"},{"openapi":"post /v1/ai-gif-generator","title":"AI GIF Generator API Reference - Magic Hour Docs","sidebarTitle":"AI GIF Generator","href":"/api-reference/image-projects/ai-gif-generator"},{"openapi":"post /v1/ai-image-editor","title":"AI Image Editor API Reference - Magic Hour Docs","sidebarTitle":"AI Image Editor","href":"/api-reference/image-projects/ai-image-editor"},{"openapi":"post /v1/ai-headshot-generator","title":"AI Headshot Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Headshot Generator","href":"/api-reference/image-projects/ai-headshot-generator"},{"openapi":"post /v1/ai-image-generator","title":"AI Image Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Image Generator","href":"/api-reference/image-projects/ai-image-generator"},{"openapi":"post /v1/ai-image-upscaler","title":"AI Image Upscaler API Reference - Magic Hour Docs","sidebarTitle":"AI Image Upscaler","href":"/api-reference/image-projects/ai-image-upscaler"},{"openapi":"post /v1/ai-meme-generator","title":"AI Meme Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Meme Generator","href":"/api-reference/image-projects/ai-meme-generator"},{"openapi":"post /v1/ai-qr-code-generator","title":"AI QR Code Generator API Reference - Magic Hour Docs","sidebarTitle":"AI QR Code Generator","href":"/api-reference/image-projects/ai-qr-code-generator"},{"openapi":"post /v1/body-swap","title":"Body Swap","href":"/api-reference/image-projects/body-swap"},{"openapi":"post /v1/face-swap-photo","title":"Face Swap Photo API Reference - Magic Hour Docs","sidebarTitle":"Face Swap Photo","href":"/api-reference/image-projects/face-swap-photo"},{"openapi":"post /v1/head-swap","title":"Head Swap API Reference - Magic Hour Docs","sidebarTitle":"Head Swap","href":"/api-reference/image-projects/head-swap"},{"openapi":"post /v1/image-background-remover","title":"Image Background Remover API Reference - Magic Hour Docs","sidebarTitle":"Image Background Remover","href":"/api-reference/image-projects/image-background-remover"},{"openapi":"post /v1/photo-colorizer","title":"Photo Colorizer API Reference - Magic Hour Docs","sidebarTitle":"Photo Colorizer","href":"/api-reference/image-projects/photo-colorizer"}]},{"group":"Audio Projects","pages":[{"openapi":"get /v1/audio-projects/{id}","title":"Get Audio Details API Reference - Magic Hour Docs","sidebarTitle":"Get Audio Details","href":"/api-reference/audio-projects/get-audio-details"},{"openapi":"delete /v1/audio-projects/{id}","title":"Delete Audio API Reference - Magic Hour Docs","sidebarTitle":"Delete Audio","href":"/api-reference/audio-projects/delete-audio"},{"openapi":"post /v1/ai-music-generator","title":"AI Music Generator","href":"/api-reference/audio-projects/ai-music-generator"},{"openapi":"post /v1/ai-voice-generator","title":"AI Voice Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Voice Generator","href":"/api-reference/audio-projects/ai-voice-generator"},{"openapi":"post /v1/ai-voice-cloner","title":"AI Voice Cloner API Reference - Magic Hour Docs","sidebarTitle":"AI Voice Cloner","href":"/api-reference/audio-projects/ai-voice-cloner"}]}],"groups":[{"group":"Account","pages":[{"openapi":"get /v1/account","title":"Get account details","href":"/api-reference/account/get-account-details"}]},{"group":"Files","pages":[{"openapi":"get /v1/saved-items","title":"List saved items","href":"/api-reference/files/list-saved-items"},{"openapi":"post /v1/files/upload-urls","title":"Generate Asset Upload Urls API Reference - Magic Hour Docs","sidebarTitle":"Generate Asset Upload Urls","href":"/api-reference/files/generate-asset-upload-urls"},{"openapi":"get /v1/face-detection/{id}","title":"Get Face Detection Details API Reference - Magic Hour Docs","sidebarTitle":"Get Face Detection Details","href":"/api-reference/files/get-face-detection-details"},{"openapi":"post /v1/face-detection","title":"Face Detection API Reference - Magic Hour Docs","sidebarTitle":"Face Detection","href":"/api-reference/files/face-detection"}]},{"group":"Video Projects","pages":[{"openapi":"get /v1/video-projects/{id}","title":"Get Video Details API Reference - Magic Hour Docs","sidebarTitle":"Get Video Details","href":"/api-reference/video-projects/get-video-details"},{"openapi":"delete /v1/video-projects/{id}","title":"Delete Video API Reference - Magic Hour Docs","sidebarTitle":"Delete Video","href":"/api-reference/video-projects/delete-video"},{"openapi":"post /v1/ai-talking-photo","title":"AI Talking Photo API Reference - Magic Hour Docs","sidebarTitle":"AI Talking Photo","href":"/api-reference/video-projects/ai-talking-photo"},{"openapi":"post /v1/ai-ugc-ad","title":"AI UGC Ad Generator","href":"/api-reference/video-projects/ai-ugc-ad-generator"},{"openapi":"post /v1/ai-video-editor","title":"AI Video Editor","href":"/api-reference/video-projects/ai-video-editor"},{"openapi":"post /v1/ai-video-translator","title":"AI Video Translator","href":"/api-reference/video-projects/ai-video-translator"},{"openapi":"post /v1/ai-video-upscaler","title":"AI Video Upscaler","href":"/api-reference/video-projects/ai-video-upscaler"},{"openapi":"post /v1/animation","title":"Animation API Reference - Magic Hour Docs","sidebarTitle":"Animation","href":"/api-reference/video-projects/animation"},{"openapi":"post /v1/audio-to-video","title":"Audio-to-Video","href":"/api-reference/video-projects/audio-to-video"},{"openapi":"post /v1/auto-subtitle-generator","title":"Auto Subtitle Generator API Reference - Magic Hour Docs","sidebarTitle":"Auto Subtitle Generator","href":"/api-reference/video-projects/auto-subtitle-generator"},{"openapi":"post /v1/character-replace","title":"Character Replace API Reference - Magic Hour Docs","sidebarTitle":"Character Replace","description":"**What this API does**\n\nCreate the same Character Replace 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.\n \n**Good for**\n- Automation and batch processing \n- Adding character replace into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) 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`. \n2) Send a request to create a character replace job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/character-replace).","href":"/api-reference/video-projects/character-replace"},{"openapi":"post /v1/face-swap","title":"Face Swap Video API Reference - Magic Hour Docs","sidebarTitle":"Face Swap Video","href":"/api-reference/video-projects/face-swap-video"},{"openapi":"post /v1/image-to-video","title":"Image-to-Video API Reference - Magic Hour Docs","sidebarTitle":"Image-to-Video","description":"**What this API does**\n\nCreate the same Image To Video 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.\n \n**Good for**\n- Automation and batch processing \n- Adding image to video into apps, pipelines, or tools \n\n**How it works (3 steps)**\n1) 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`. \n2) Send a request to create a image to video job with the basic fields. \n3) Check the job status until it's `complete`, then download the result from `downloads`.\n\n**Key options**\n- Inputs: usually a file, sometimes a YouTube link, depending on project type \n- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.\n- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt \n\n**Cost** \nCredits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.\n\nFor detailed examples, see the [product page](https://magichour.ai/products/image-to-video).","href":"/api-reference/video-projects/image-to-video"},{"openapi":"post /v1/lip-sync","title":"Lip Sync API Reference - Magic Hour Docs","sidebarTitle":"Lip Sync","href":"/api-reference/video-projects/lip-sync"},{"openapi":"post /v1/text-to-video","title":"Text-to-Video API Reference - Magic Hour Docs","sidebarTitle":"Text-to-Video","href":"/api-reference/video-projects/text-to-video"},{"openapi":"post /v1/video-to-video","title":"Video-to-Video API Reference - Magic Hour Docs","sidebarTitle":"Video-to-Video","href":"/api-reference/video-projects/video-to-video"}]},{"group":"Image Projects","pages":[{"openapi":"get /v1/image-projects/{id}","title":"Get Image Details API Reference - Magic Hour Docs","sidebarTitle":"Get Image Details","href":"/api-reference/image-projects/get-image-details"},{"openapi":"delete /v1/image-projects/{id}","title":"Delete Image API Reference - Magic Hour Docs","sidebarTitle":"Delete Image","href":"/api-reference/image-projects/delete-image"},{"openapi":"post /v1/ai-clothes-changer","title":"AI Clothes Changer API Reference - Magic Hour Docs","sidebarTitle":"AI Clothes Changer","href":"/api-reference/image-projects/ai-clothes-changer"},{"openapi":"post /v1/ai-face-editor","title":"AI Face Editor API Reference - Magic Hour Docs","sidebarTitle":"AI Face Editor","href":"/api-reference/image-projects/ai-face-editor"},{"openapi":"post /v1/ai-gif-generator","title":"AI GIF Generator API Reference - Magic Hour Docs","sidebarTitle":"AI GIF Generator","href":"/api-reference/image-projects/ai-gif-generator"},{"openapi":"post /v1/ai-image-editor","title":"AI Image Editor API Reference - Magic Hour Docs","sidebarTitle":"AI Image Editor","href":"/api-reference/image-projects/ai-image-editor"},{"openapi":"post /v1/ai-headshot-generator","title":"AI Headshot Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Headshot Generator","href":"/api-reference/image-projects/ai-headshot-generator"},{"openapi":"post /v1/ai-image-generator","title":"AI Image Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Image Generator","href":"/api-reference/image-projects/ai-image-generator"},{"openapi":"post /v1/ai-image-upscaler","title":"AI Image Upscaler API Reference - Magic Hour Docs","sidebarTitle":"AI Image Upscaler","href":"/api-reference/image-projects/ai-image-upscaler"},{"openapi":"post /v1/ai-meme-generator","title":"AI Meme Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Meme Generator","href":"/api-reference/image-projects/ai-meme-generator"},{"openapi":"post /v1/ai-qr-code-generator","title":"AI QR Code Generator API Reference - Magic Hour Docs","sidebarTitle":"AI QR Code Generator","href":"/api-reference/image-projects/ai-qr-code-generator"},{"openapi":"post /v1/body-swap","title":"Body Swap","href":"/api-reference/image-projects/body-swap"},{"openapi":"post /v1/face-swap-photo","title":"Face Swap Photo API Reference - Magic Hour Docs","sidebarTitle":"Face Swap Photo","href":"/api-reference/image-projects/face-swap-photo"},{"openapi":"post /v1/head-swap","title":"Head Swap API Reference - Magic Hour Docs","sidebarTitle":"Head Swap","href":"/api-reference/image-projects/head-swap"},{"openapi":"post /v1/image-background-remover","title":"Image Background Remover API Reference - Magic Hour Docs","sidebarTitle":"Image Background Remover","href":"/api-reference/image-projects/image-background-remover"},{"openapi":"post /v1/photo-colorizer","title":"Photo Colorizer API Reference - Magic Hour Docs","sidebarTitle":"Photo Colorizer","href":"/api-reference/image-projects/photo-colorizer"}]},{"group":"Audio Projects","pages":[{"openapi":"get /v1/audio-projects/{id}","title":"Get Audio Details API Reference - Magic Hour Docs","sidebarTitle":"Get Audio Details","href":"/api-reference/audio-projects/get-audio-details"},{"openapi":"delete /v1/audio-projects/{id}","title":"Delete Audio API Reference - Magic Hour Docs","sidebarTitle":"Delete Audio","href":"/api-reference/audio-projects/delete-audio"},{"openapi":"post /v1/ai-music-generator","title":"AI Music Generator","href":"/api-reference/audio-projects/ai-music-generator"},{"openapi":"post /v1/ai-voice-cloner","title":"AI Voice Cloner API Reference - Magic Hour Docs","sidebarTitle":"AI Voice Cloner","href":"/api-reference/audio-projects/ai-voice-cloner"},{"openapi":"post /v1/ai-voice-generator","title":"AI Voice Generator API Reference - Magic Hour Docs","sidebarTitle":"AI Voice Generator","href":"/api-reference/audio-projects/ai-voice-generator"}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Face Swap Video API Reference - Magic Hour Docs - Magic Hour API Docs","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}