The resources (image, video, voice) generated by our API are valid for 7 days.
Please save the relevant resources as soon as possible to prevent expiration.
Source (new) face image URLs. Each item: { "path": "url", "opts": "landmarks" }. Min 1, Max 50 items.
sourceImage[].path
string
Yes
Valid URL of the source face image. Must be a valid HTTP/HTTPS URL.
sourceImage[].opts
string
Conditional
Face landmark string from crop_landmarks of Face Detection API. Required when sourceImage or targetImage array length > 1. Optional when both arrays have exactly 1 element.
targetImage
array
Yes
Target face image URLs. Each item: { "path": "url", "opts": "landmarks" }. Min 1, Max 50 items.
targetImage[].path
string
Yes
Valid URL of the target face image. Must be a valid HTTP/HTTPS URL.
targetImage[].opts
string
Conditional
Face landmark string from crop_landmarks of Face Detection API. Required when sourceImage or targetImage array length > 1. Optional when both arrays have exactly 1 element.
model_name
string
No
Default: akool_faceswap_image_hq
webhookUrl
string
No
Callback URL for result notification
face_enhance
boolean
No
Enable face enhancement (default: false)
single_face_mode
boolean
No
When true, enables single face mode (default: false)
Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Akool open api documents","colors":{"primary":"#8458cc","light":"#8458cc","dark":"#8458cc"},"logo":{"light":"https://mintcdn.com/akoolinc/u9MBxlCI2oetjK9S/logo/akool-light.svg?fit=max\u0026auto=format\u0026n=u9MBxlCI2oetjK9S\u0026q=85\u0026s=2582701d216adf76106f6e8f9923ac06","dark":"https://mintcdn.com/akoolinc/u9MBxlCI2oetjK9S/logo/akool-dark.svg?fit=max\u0026auto=format\u0026n=u9MBxlCI2oetjK9S\u0026q=85\u0026s=82c18ef3c0fd2b749f84c5f74db06ad2"},"favicon":"https://mintcdn.com/akoolinc/u9MBxlCI2oetjK9S/favicon.svg?fit=max\u0026auto=format\u0026n=u9MBxlCI2oetjK9S\u0026q=85\u0026s=ca76b853cf720af4753831ccd6f2d69f","api":{"openapi":["openapi/live-avatar.yaml","openapi/faceswap.yaml","openapi/video-translation.yaml","openapi/talking-photo.yaml","openapi/face-detection.yaml","openapi/face-detect-legacy.yaml","openapi/swap-studio-v5.yaml"],"playground":{"display":"simple"},"mdx":{"server":"https://openapi.akool.com"}},"navbar":{"links":[{"href":"mailto:info@akool.com","label":"Support"}],"primary":{"type":"button","label":"Akool","href":"https://akool.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"akoolinc","hasAudioNarration":false,"actualSubdomain":"akoolinc","customDomains":["docs.akool.com"],"gitSource":{"type":"github","owner":"jinjuezhou","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad5e1eec7b789e3c49ec5e7","collectionId":"b12eb73c-27b0-45cf-aaf5-d6a1adc2f5bc","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad5e1eec7b789e3c49ec5e7"},"entitlements":{},"buildId":"6ad5e1eec7b789e3c49ec5e7","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":82},{"language":"default","tag":"API Endpoints","count":50},{"language":"default","tag":"Swap Studio V5","count":27},{"language":"default","tag":"Streaming Avatar","count":15},{"language":"default","tag":"AI Tools Suite","count":11},{"language":"default","tag":"Face Swap","count":9},{"language":"default","tag":"Image to Video","count":7},{"language":"default","tag":"Character Swap V5","count":6},{"language":"default","tag":"Clothing Swap V5","count":6},{"language":"default","tag":"Head Swap V5","count":6}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"editor-nav-generations","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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"ai-tools-suite/faceswap/image-faceswap-v4","slug":"/ai-tools-suite/faceswap/image-faceswap-v4","pageMetadata":{"title":"Face Swap Pro","description":"Highest quality face swap for images","openapi":"POST /api/open/v4/faceswap/faceswapByImage","href":"/ai-tools-suite/faceswap/image-faceswap-v4"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Highest quality face swap for images\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsx(_components.p,{children:`The resources (image, video, voice) generated by our API are valid for 7 days.\nPlease save the relevant resources as soon as possible to prevent expiration.`})}),`\n`,_jsx(Heading,{level:`2`,id:`face-swap-pro-akool_faceswap_image_hq`,children:`Face Swap Pro (akool_faceswap_image_hq)`}),`\n`,_jsx(_components.p,{children:`Face Swap Pro delivers the highest quality face swap results for images:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`More Realistic`}),`: Advanced algorithm produces natural and lifelike face swaps`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`More Similar`}),`: Enhanced matching ensures high similarity to the source face`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Simplified Integration`}),`: `,_jsx(_components.code,{children:`opts`}),` parameter is optional, no face detection step required`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Batch Support`}),`: Supports up to 50 sourceImage / targetImage pairs per request`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Optional Face Landmarks`}),`: Provide `,_jsx(_components.code,{children:`opts`}),` from the `,_jsx(_components.a,{href:`/ai-tools-suite/face-detection/detect-faces`,children:`Face Detection API`}),` for improved accuracy`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`parameters`,children:`Parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sourceImage`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`Source (new) face image URLs. Each item: `,_jsx(_components.code,{children:`{ \"path\": \"url\", \"opts\": \"landmarks\" }`}),`. Min 1, Max 50 items.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sourceImage[].path`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Valid URL of the source face image. Must be a valid HTTP/HTTPS URL.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sourceImage[].opts`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Conditional`}),_jsxs(_components.td,{children:[`Face landmark string from `,_jsx(_components.code,{children:`crop_landmarks`}),` of `,_jsx(_components.a,{href:`/ai-tools-suite/face-detection/detect-faces`,children:`Face Detection API`}),`. `,_jsx(_components.strong,{children:`Required`}),` when `,_jsx(_components.code,{children:`sourceImage`}),` or `,_jsx(_components.code,{children:`targetImage`}),` array length > 1. `,_jsx(_components.strong,{children:`Optional`}),` when both arrays have exactly 1 element.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`targetImage`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`Target face image URLs. Each item: `,_jsx(_components.code,{children:`{ \"path\": \"url\", \"opts\": \"landmarks\" }`}),`. Min 1, Max 50 items.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`targetImage[].path`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Valid URL of the target face image. Must be a valid HTTP/HTTPS URL.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`targetImage[].opts`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Conditional`}),_jsxs(_components.td,{children:[`Face landmark string from `,_jsx(_components.code,{children:`crop_landmarks`}),` of `,_jsx(_components.a,{href:`/ai-tools-suite/face-detection/detect-faces`,children:`Face Detection API`}),`. `,_jsx(_components.strong,{children:`Required`}),` when `,_jsx(_components.code,{children:`sourceImage`}),` or `,_jsx(_components.code,{children:`targetImage`}),` array length > 1. `,_jsx(_components.strong,{children:`Optional`}),` when both arrays have exactly 1 element.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`model_name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Default: `,_jsx(_components.code,{children:`akool_faceswap_image_hq`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhookUrl`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Callback URL for result notification`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`face_enhance`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Enable face enhancement (default: false)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`single_face_mode`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`When `,_jsx(_components.code,{children:`true`}),`, enables single face mode (default: false)`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`getting-opts-value`,children:`Getting opts Value`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`opts`}),` parameter provides face landmark coordinates for improved face alignment accuracy. To get the `,_jsx(_components.code,{children:`opts`}),` value:`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Call the `,_jsx(_components.a,{href:`/ai-tools-suite/face-detection/detect-faces`,children:`Face Detection API`}),` with your image URL`]}),`\n`,_jsxs(_components.li,{children:[`Use the `,_jsx(_components.code,{children:`crop_landmarks`}),` value from the response as the `,_jsx(_components.code,{children:`opts`}),` parameter`]}),`\n`,_jsxs(_components.li,{children:[`Format: colon-separated coordinate pairs, e.g. `,_jsx(_components.code,{children:`\"262,175:363,175:313,215:272,279\"`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`important-notes`,children:`Important Notes`}),`\n`,_jsx(Heading,{level:`3`,id:`parameter-validation-rules`,children:`Parameter Validation Rules`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`path`}),` validation`]}),`: Each `,_jsx(_components.code,{children:`path`}),` must be a valid HTTP/HTTPS URL. Invalid URLs will be rejected.`]}),`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`opts`}),` conditional requirement`]}),`:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`When both `,_jsx(_components.code,{children:`sourceImage`}),` and `,_jsx(_components.code,{children:`targetImage`}),` arrays have exactly `,_jsx(_components.strong,{children:`1 element each`}),`: `,_jsx(_components.code,{children:`opts`}),` is `,_jsx(_components.strong,{children:`optional`}),` for all elements`]}),`\n`,_jsxs(_components.li,{children:[`When either `,_jsx(_components.code,{children:`sourceImage`}),` or `,_jsx(_components.code,{children:`targetImage`}),` array has `,_jsx(_components.strong,{children:`more than 1 element`}),`: `,_jsx(_components.code,{children:`opts`}),` is `,_jsx(_components.strong,{children:`required`}),` for `,_jsx(_components.strong,{children:`every element`}),` in both arrays`]}),`\n`,_jsxs(_components.li,{children:[`If any element is missing `,_jsx(_components.code,{children:`opts`}),` when required, the request will be rejected with a validation error`]}),`\n`]}),`\n`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`usage-guidelines`,children:`Usage Guidelines`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`For single face swap (1 source + 1 target): `,_jsx(_components.code,{children:`opts`}),` is optional but recommended for better accuracy`]}),`\n`,_jsxs(_components.li,{children:[`For batch face swap (multiple faces): `,_jsx(_components.code,{children:`opts`}),` is required for all elements to ensure proper face mapping`]}),`\n`,_jsxs(_components.li,{children:[`For multi-face swap, image + video support, or video segment swap, use `,_jsx(_components.a,{href:`/ai-tools-suite/faceswap/faceswap-plus`,children:`Face Swap Plus`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`example-single-face-swap-opts-optional`,children:`Example: Single Face Swap (opts Optional)`}),`\n`,_jsxs(_components.p,{children:[`When both arrays have exactly 1 element, `,_jsx(_components.code,{children:`opts`}),` is optional:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sourceImage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/new-face.jpg\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"targetImage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/original.jpg\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"model_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"akool_faceswap_image_hq\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"face_enhance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"single_face_mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`example-single-face-swap-with-opts-recommended`,children:`Example: Single Face Swap with opts (Recommended)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`17`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`17`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sourceImage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/new-face.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"opts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"239,364:386,366:317,472:266,539\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"targetImage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/original.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"opts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"262,175:363,175:313,215:272,279\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"model_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"akool_faceswap_image_hq\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"face_enhance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"single_face_mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`example-batch-face-swap-opts-required`,children:`Example: Batch Face Swap (opts Required)`}),`\n`,_jsxs(_components.p,{children:[`When either array has more than 1 element, `,_jsx(_components.code,{children:`opts`}),` is `,_jsx(_components.strong,{children:`required`}),` for `,_jsx(_components.strong,{children:`all elements`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`25`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`25`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sourceImage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/new-face-1.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"opts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"239,364:386,366:317,472:266,539\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/new-face-2.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"opts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"150,200:250,200:200,250:180,300\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"targetImage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/original.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"opts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"262,175:363,175:313,215:272,279\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/original-2.jpg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"opts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"100,150:200,150:150,200:120,250\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"model_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"akool_faceswap_image_hq\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"face_enhance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"single_face_mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Face Swap Pro","description":"Highest quality face swap for images","openapi":"POST /api/open/v4/faceswap/faceswapByImage","href":"/ai-tools-suite/faceswap/image-faceswap-v4"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Face Swap Pro (akool_faceswap_image_hq)","slug":"face-swap-pro-akool_faceswap_image_hq","depth":2,"children":[]},{"title":"Parameters","slug":"parameters","depth":2,"children":[]},{"title":"Getting opts Value","slug":"getting-opts-value","depth":2,"children":[]},{"title":"Important Notes","slug":"important-notes","depth":2,"children":[{"title":"Parameter Validation Rules","slug":"parameter-validation-rules","depth":3,"children":[]},{"title":"Usage Guidelines","slug":"usage-guidelines","depth":3,"children":[]}]},{"title":"Example: Single Face Swap (opts Optional)","slug":"example-single-face-swap-opts-optional","depth":2,"children":[]},{"title":"Example: Single Face Swap with opts (Recommended)","slug":"example-single-face-swap-with-opts-recommended","depth":2,"children":[]},{"title":"Example: Batch Face Swap (opts Required)","slug":"example-batch-face-swap-opts-required","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Face Swap Pro","description":"Highest quality face swap for images","tags":["Face Swap"],"requestBody":"cd6e2926-b280-4a1c-a2d7-2375463ff98f","responses":{"200":"6d720ae6-1ee3-4482-8dda-f3ad12653f1a"},"method":"post","type":"path","servers":["6411023e-c1a8-4acf-8bbb-7da0c8fdeb66"],"security":["d2376db7-2827-4241-b990-85f8e9120b0a","65a4bdf6-5899-4790-baaf-c765306471b6"],"path":"/api/open/v4/faceswap/faceswapByImage","baseUrlOptions":["https://openapi.akool.com"],"title":"Face Swap Pro","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sourceImage","targetImage"],"properties":{"sourceImage":{"type":"array","items":{"type":"object","required":["path"],"properties":{"path":{"type":"string","format":"uri","description":"Valid URL of the face image. Must be a valid HTTP/HTTPS URL.\nInvalid URLs will be rejected during validation.\n","isRequired":true,"uniqueKey":"sourceImage.items.[INDEX].path","typeLabel":"string\u003curi>"},"opts":{"type":"string","description":"Face landmark coordinates string (conditional requirement).\nYou can get this value from the `crop_landmarks` field returned by the [Face Detection API](/ai-tools-suite/face-detection/detect-faces).\n\n**Required** when `sourceImage` or `targetImage` array length > 1.\n**Optional** when both `sourceImage` and `targetImage` arrays have exactly 1 element each.\n\nWhen provided, improves face alignment accuracy.\nFormat: colon-separated coordinate pairs, e.g. \"262,175:363,175:313,215:272,279\"\n","uniqueKey":"sourceImage.items.[INDEX].opts","typeLabel":"string"}},"uniqueKey":"sourceImage.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":50,"description":"Source (new) face image URL array. Each item contains `path` (required, must be valid URL) and `opts` (conditional).\n\n**`opts` requirement**:\n- **Required** when `sourceImage` or `targetImage` array length > 1 (all elements must have `opts`)\n- **Optional** when both `sourceImage` and `targetImage` arrays have exactly 1 element each\n\nThe `opts` value comes from the `crop_landmarks` field returned by the [Face Detection API](/ai-tools-suite/face-detection/detect-faces).\n","isRequired":true,"uniqueKey":"sourceImage","typeLabel":"object[]"},"targetImage":{"type":"array","items":{"type":"object","required":["path"],"properties":{"path":{"type":"string","format":"uri","description":"Valid URL of the face image. Must be a valid HTTP/HTTPS URL.\nInvalid URLs will be rejected during validation.\n","isRequired":true,"uniqueKey":"targetImage.items.[INDEX].path","typeLabel":"string\u003curi>"},"opts":{"type":"string","description":"Face landmark coordinates string (conditional requirement).\nYou can get this value from the `crop_landmarks` field returned by the [Face Detection API](/ai-tools-suite/face-detection/detect-faces).\n\n**Required** when `sourceImage` or `targetImage` array length > 1.\n**Optional** when both `sourceImage` and `targetImage` arrays have exactly 1 element each.\n\nWhen provided, improves face alignment accuracy.\nFormat: colon-separated coordinate pairs, e.g. \"262,175:363,175:313,215:272,279\"\n","uniqueKey":"targetImage.items.[INDEX].opts","typeLabel":"string"}},"uniqueKey":"targetImage.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":50,"description":"Target face image URL array. Each item contains `path` (required, must be valid URL) and `opts` (conditional).\n\n**`opts` requirement**:\n- **Required** when `sourceImage` or `targetImage` array length > 1 (all elements must have `opts`)\n- **Optional** when both `sourceImage` and `targetImage` arrays have exactly 1 element each\n\nThe `opts` value comes from the `crop_landmarks` field returned by the [Face Detection API](/ai-tools-suite/face-detection/detect-faces).\n","isRequired":true,"uniqueKey":"targetImage","typeLabel":"object[]"},"model_name":{"type":"string","enum":["akool_faceswap_image_hq"],"default":"akool_faceswap_image_hq","description":"Model name (default: `akool_faceswap_image_hq`)","uniqueKey":"model_name","typeLabel":"enum\u003cstring>"},"webhookUrl":{"type":"string","description":"Callback URL for result notification","uniqueKey":"webhookUrl","typeLabel":"string"},"face_enhance":{"type":"boolean","default":false,"description":"Whether to enable face enhancement (default false)","uniqueKey":"face_enhance","typeLabel":"boolean"},"single_face_mode":{"type":"boolean","default":false,"description":"When `true`, enables single face mode for simplified single-face swap.\nWhen `false` (default), standard mode.\n","uniqueKey":"single_face_mode","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"sourceImage":[{"path":"https://example.com/new-face.jpg"}],"targetImage":[{"path":"https://example.com/original.jpg"}],"model_name":"akool_faceswap_image_hq","face_enhance":false},"examples":{"Example":{"title":"Example","value":{"sourceImage":[{"path":"https://example.com/new-face.jpg"}],"targetImage":[{"path":"https://example.com/original.jpg"}],"model_name":"akool_faceswap_image_hq","face_enhance":false}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"6d720ae6-1ee3-4482-8dda-f3ad12653f1a":{"description":"Faceswap request submitted successfully","content":{"application/json":{"schema":{"type":"object","required":["code","msg"],"properties":{"code":{"type":"integer","description":"Interface returns business status code (1000: success)","example":1000,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Interface returns status information","example":"OK","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"data":{"type":"object","properties":{"_id":{"type":"string","description":"Interface returns data ID","uniqueKey":"data._id","typeLabel":"string"},"job_id":{"type":"string","description":"Task processing unique ID","uniqueKey":"data.job_id","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":1000,"msg":"OK","data":{"_id":"6593c94c0ef703e8c055e3c8","job_id":"20240102082900592-5653"}},"examples":{"Example":{"title":"Example","value":{"code":1000,"msg":"OK","data":{"_id":"6593c94c0ef703e8c055e3c8","job_id":"20240102082900592-5653"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d2376db7-2827-4241-b990-85f8e9120b0a":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.","scopes":[],"schemeName":"ApiKeyAuth"}},"65a4bdf6-5899-4790-baaf-c765306471b6":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Your API Key used for request authorization. Get Token from authentication/usage#get-the-token","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"6411023e-c1a8-4acf-8bbb-7da0c8fdeb66":{"url":"https://openapi.akool.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API Key used for request authorization. Get Token from authentication/usage#get-the-token","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API Key used for request authorization. Get Token from authentication/usage#get-the-token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/faceswap.yaml"},"subdomain":"akoolinc","siteName":"Akool open api documents","title":"Face Swap Pro - Akool open api documents","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-06T10:24:10.234Z","originalFileLocation":"ai-tools-suite/faceswap/image-faceswap-v4.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=\"system\"}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=\"Highest quality face swap for images\">\u003cmeta data-mint-head name=\"application-name\" content=\"Akool open api documents\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/akoolinc/qGYShipUZpalh1A-/_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/akoolinc/qGYShipUZpalh1A-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/akoolinc/qGYShipUZpalh1A-/_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/akoolinc/qGYShipUZpalh1A-/_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/akoolinc/qGYShipUZpalh1A-/_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/akoolinc/qGYShipUZpalh1A-/_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/akoolinc/qGYShipUZpalh1A-/_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/akoolinc/qGYShipUZpalh1A-/_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/akoolinc/qGYShipUZpalh1A-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Face Swap Pro - Akool open api documents\">\u003cmeta data-mint-head property=\"og:description\" content=\"Highest quality face swap for images\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Akool open api documents\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://akoolinc.mintlify.app/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Face+Swap+Pro\u0026amp;description=Highest+quality+face+swap+for+images\u0026amp;theme=7d7e450ed224174404f3747e\u0026amp;signature=e62bc5a8113f25316f8575cfc25eb4692785a0a765a62783a5537a59b51fd2be\">\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 Pro - Akool open api documents\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Highest quality face swap for images\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://akoolinc.mintlify.app/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Face+Swap+Pro\u0026amp;description=Highest+quality+face+swap+for+images\u0026amp;theme=7d7e450ed224174404f3747e\u0026amp;signature=e62bc5a8113f25316f8575cfc25eb4692785a0a765a62783a5537a59b51fd2be\">\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/akoolinc/qGYShipUZpalh1A-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Akool open api documents\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8458cc\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ai-tools-suite/faceswap/image-faceswap-v4.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.akool.com/#organization\",\"name\":\"Akool open api documents\",\"url\":\"https://docs.akool.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/akoolinc/u9MBxlCI2oetjK9S/logo/akool-light.svg?fit=max\u0026auto=format\u0026n=u9MBxlCI2oetjK9S\u0026q=85\u0026s=2582701d216adf76106f6e8f9923ac06\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.akool.com#website\",\"name\":\"Akool open api documents\",\"url\":\"https://docs.akool.com\",\"publisher\":{\"@id\":\"https://docs.akool.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4#webpage\",\"url\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4\",\"name\":\"Face Swap Pro\",\"description\":\"Highest quality face swap for images\",\"dateModified\":\"2026-05-06T10:24:10.234Z\",\"isPartOf\":{\"@id\":\"https://docs.akool.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Face Swap\",\"item\":\"https://docs.akool.com/ai-tools-suite/faceswap\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Endpoints\",\"item\":\"https://docs.akool.com/ai-tools-suite/faceswap/faceswap-plus\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Face Swap Pro\",\"item\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4#apireference\",\"headline\":\"Face Swap Pro\",\"name\":\"Face Swap Pro\",\"description\":\"Highest quality face swap for images\",\"url\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4\",\"mainEntityOfPage\":{\"@id\":\"https://docs.akool.com/ai-tools-suite/faceswap/image-faceswap-v4#webpage\"},\"dateModified\":\"2026-05-06T10:24:10.234Z\",\"publisher\":{\"@id\":\"https://docs.akool.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.akool.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Akool open api documents\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Akool open api documents","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Authentication","pages":[{"title":"Usage","href":"/authentication/usage"}]},{"group":"Face Swap","pages":[{"title":"Face Swap API Overview","href":"/ai-tools-suite/faceswap"},{"group":"API Endpoints","pages":[{"title":"Face Swap Plus (Image \u0026 Video)","description":"Multi-face swap for images and videos","openapi":"POST /api/open/v4/faceswap/faceswapPlusByImage","href":"/ai-tools-suite/faceswap/faceswap-plus"},{"title":"Face Swap Pro","openapi":"POST /api/open/v4/faceswap/faceswapByImage","href":"/ai-tools-suite/faceswap/image-faceswap-v4"},{"title":"Image Faceswap","description":"Swap faces in images with high quality","openapi":"POST /api/open/v3/faceswap/highquality/specifyimage","href":"/ai-tools-suite/faceswap/image-faceswap"},{"title":"Video Faceswap","openapi":"POST /api/open/v3/faceswap/highquality/specifyvideo","href":"/ai-tools-suite/faceswap/video-faceswap"},{"title":"Get Faceswap Result List","openapi":"GET /api/open/v3/faceswap/result/listbyids","href":"/ai-tools-suite/faceswap/get-result"},{"title":"Delete Faceswap Results","openapi":"POST /api/open/v3/faceswap/result/delbyids","href":"/ai-tools-suite/faceswap/delete-result"},{"title":"Get User Credit Info","openapi":"GET /api/open/v3/faceswap/quota/info","href":"/ai-tools-suite/faceswap/get-credit"},{"title":"Face Detect (Legacy)","openapi":"POST /detect","href":"/ai-tools-suite/faceswap/face-detect"}]}]},{"group":"Streaming Avatar","pages":[{"title":"Streaming Avatar API Overview","href":"/ai-tools-suite/live-avatar"},{"group":"API Endpoints","pages":[{"title":"Upload Streaming Avatar","openapi":"POST /api/open/v3/avatar/create","href":"/ai-tools-suite/live-avatar/upload"},{"title":"Get Streaming Avatar List","openapi":"GET /api/open/v4/liveAvatar/avatar/list","href":"/ai-tools-suite/live-avatar/list"},{"title":"Get Streaming Avatar Detail","openapi":"GET /api/open/v4/liveAvatar/avatar/detail","href":"/ai-tools-suite/live-avatar/detail"},{"title":"Create Session","openapi":"POST /api/open/v4/liveAvatar/session/create","href":"/ai-tools-suite/live-avatar/create-session"},{"title":"Get Session Detail","openapi":"GET /api/open/v4/liveAvatar/session/detail","href":"/ai-tools-suite/live-avatar/session-detail"},{"title":"Close Session","openapi":"POST /api/open/v4/liveAvatar/session/close","href":"/ai-tools-suite/live-avatar/close-session"},{"title":"Get Session List","openapi":"GET /api/open/v4/liveAvatar/session/list","href":"/ai-tools-suite/live-avatar/list-sessions"}]},{"group":"Implementation Guides","pages":[{"title":"Streaming Avatar Integration Guide","href":"/implementation-guide/streaming-avatar"},{"title":"LiveKit Agent Integration","href":"/implementation-guide/livekit-agent"}]},{"group":"Integrate with AKOOL SA SDK","pages":[{"title":"Streaming Avatar SDK Quick Start","href":"/sdk/jssdk-start"},{"title":"Streaming Avatar SDK Best Practices","href":"/sdk/jssdk-best-practice"},{"title":"Streaming Avatar SDK API Reference","href":"/sdk/jssdk-api"}]},{"title":"Knowledge Base","href":"/ai-tools-suite/knowledge-base"},{"title":"Vision Sense","href":"/ai-tools-suite/live-camera"}]},{"group":"Talking Photo","pages":[{"title":"Talking Photo API Overview","href":"/ai-tools-suite/talking-photo"},{"group":"API Endpoints","pages":[{"title":"Create By Talking Photo","openapi":"POST /api/open/v3/content/video/createbytalkingphoto","href":"/ai-tools-suite/talking-photo/create-video"},{"title":"Get Video Info Result","openapi":"GET /api/open/v3/content/video/infobymodelid","href":"/ai-tools-suite/talking-photo/get-result"}]}]},{"group":"Video Translation","pages":[{"title":"Video Translation API Overview","href":"/ai-tools-suite/video-translation"},{"group":"API Endpoints","pages":[{"title":"Create Video Translation","openapi":"POST /api/open/v3/content/video/createbytranslate","href":"/ai-tools-suite/video-translation/create-translation"},{"title":"Get Video Translation Result","openapi":"GET /api/open/v3/content/video/infobymodelid","href":"/ai-tools-suite/video-translation/get-result"},{"title":"Get Language List","openapi":"GET /api/open/v3/language/list","href":"/ai-tools-suite/video-translation/get-languages"}]}]},{"group":"Face Detection","pages":[{"title":"Face Detection API Overview","href":"/ai-tools-suite/face-detection"},{"title":"Detect Faces","openapi":"POST /detect_faces","href":"/ai-tools-suite/face-detection/detect-faces"},{"title":"Analyze Frames","openapi":"POST /faceswap/analyze_frames","href":"/ai-tools-suite/face-detection/analyze-frames"}]},{"group":"Swap Studio V5","pages":[{"title":"Swap Studio V5","href":"/ai-tools-suite/swap-studio/overview"},{"group":"Character Swap V5","pages":[{"title":"Character Swap V5 API Overview","href":"/ai-tools-suite/swap-studio/character-swap-v5"},{"group":"API Endpoints","pages":[{"title":"List Models","openapi":"GET /api/open/v5/characterSwap/models","href":"/ai-tools-suite/swap-studio/character-swap-v5/models"},{"title":"Create Task","openapi":"POST /api/open/v5/characterSwap/create","href":"/ai-tools-suite/swap-studio/character-swap-v5/create"},{"title":"Get Task Result","openapi":"GET /api/open/v5/characterSwap/task/detail","href":"/ai-tools-suite/swap-studio/character-swap-v5/get-result"},{"title":"Analyze Source Material","openapi":"POST /api/open/v5/characterSwap/analyze","href":"/ai-tools-suite/swap-studio/character-swap-v5/analyze"},{"title":"Get Analysis Result","openapi":"GET /api/open/v5/characterSwap/analyze/detail","href":"/ai-tools-suite/swap-studio/character-swap-v5/analysis-result"}]}]},{"group":"Motion Swap V5","pages":[{"title":"Motion Swap V5 API Overview","href":"/ai-tools-suite/swap-studio/motion-swap-v5"},{"group":"API Endpoints","pages":[{"title":"List Models","openapi":"GET /api/open/v5/motionSwap/models","href":"/ai-tools-suite/swap-studio/motion-swap-v5/models"},{"title":"Create Task","openapi":"POST /api/open/v5/motionSwap/create","href":"/ai-tools-suite/swap-studio/motion-swap-v5/create"},{"title":"Get Task Result","openapi":"GET /api/open/v5/motionSwap/task/detail","href":"/ai-tools-suite/swap-studio/motion-swap-v5/get-result"}]}]},{"group":"Head Swap V5","pages":[{"title":"Head Swap V5 API Overview","href":"/ai-tools-suite/swap-studio/head-swap-v5"},{"group":"API Endpoints","pages":[{"title":"List Models","openapi":"GET /api/open/v5/headswap/models","href":"/ai-tools-suite/swap-studio/head-swap-v5/models"},{"title":"Create Task","openapi":"POST /api/open/v5/headswap/create","href":"/ai-tools-suite/swap-studio/head-swap-v5/create"},{"title":"Get Task Result","openapi":"GET /api/open/v5/headswap/task/detail","href":"/ai-tools-suite/swap-studio/head-swap-v5/get-result"},{"title":"Analyze Source Material","openapi":"POST /api/open/v5/headswap/analyze","href":"/ai-tools-suite/swap-studio/head-swap-v5/analyze"},{"title":"Get Analysis Result","openapi":"GET /api/open/v5/headswap/analyze/detail","href":"/ai-tools-suite/swap-studio/head-swap-v5/analysis-result"}]}]},{"group":"Clothing Swap V5","pages":[{"title":"Clothing Swap V5 API Overview","href":"/ai-tools-suite/swap-studio/clothing-swap-v5"},{"group":"API Endpoints","pages":[{"title":"List Models","openapi":"GET /api/open/v5/clothingSwap/models","href":"/ai-tools-suite/swap-studio/clothing-swap-v5/models"},{"title":"Create Task","openapi":"POST /api/open/v5/clothingSwap/create","href":"/ai-tools-suite/swap-studio/clothing-swap-v5/create"},{"title":"Get Task Result","openapi":"GET /api/open/v5/clothingSwap/task/detail","href":"/ai-tools-suite/swap-studio/clothing-swap-v5/get-result"},{"title":"Analyze Source Material","openapi":"POST /api/open/v5/clothingSwap/analyze","href":"/ai-tools-suite/swap-studio/clothing-swap-v5/analyze"},{"title":"Get Analysis Result","openapi":"GET /api/open/v5/clothingSwap/analyze/detail","href":"/ai-tools-suite/swap-studio/clothing-swap-v5/analysis-result"}]}]},{"group":"Hair Swap V5","pages":[{"title":"Hair Swap V5 API Overview","href":"/ai-tools-suite/swap-studio/hair-swap-v5"},{"group":"API Endpoints","pages":[{"title":"List Models","openapi":"GET /api/open/v5/hairswap/models","href":"/ai-tools-suite/swap-studio/hair-swap-v5/models"},{"title":"Create Task","openapi":"POST /api/open/v5/hairswap/create","href":"/ai-tools-suite/swap-studio/hair-swap-v5/create"},{"title":"Get Task Result","openapi":"GET /api/open/v5/hairswap/task/detail","href":"/ai-tools-suite/swap-studio/hair-swap-v5/get-result"}]}]}]},{"group":"Image Generate","pages":[{"title":"Image Generate API Overview","href":"/ai-tools-suite/image-generate/image-generate"},{"group":"API Endpoints","pages":[{"title":"Text to Image / Image to Image","href":"/ai-tools-suite/image-generate/create-by-source-prompt"},{"title":"Generate 4K or Variations","href":"/ai-tools-suite/image-generate/create-by-button"},{"title":"Get Image Result","href":"/ai-tools-suite/image-generate/get-result"}]}]},{"group":"Image to Video","pages":[{"title":"Image to Video API Overview","href":"/ai-tools-suite/image2video/image2video"},{"group":"API Endpoints","pages":[{"title":"Create Image to Video","href":"/ai-tools-suite/image2video/create-video"},{"title":"Create Batch Image to Video","href":"/ai-tools-suite/image2video/create-batch"},{"title":"Get Image to Video Results","href":"/ai-tools-suite/image2video/get-results"},{"title":"Get Available Effects","href":"/ai-tools-suite/image2video/get-effects"},{"title":"Update Video Audio","href":"/ai-tools-suite/image2video/update-audio"},{"title":"Delete Videos","href":"/ai-tools-suite/image2video/delete-videos"}]}]},{"group":"AI Tools Suite","pages":[{"title":"Live Face Swap","href":"/ai-tools-suite/live-faceswap"},{"title":"Reage","href":"/ai-tools-suite/reage"},{"title":"VoiceLab","href":"/ai-tools-suite/voiceLab"},{"title":"Video Translation API Overview","href":"/ai-tools-suite/video-translation"},{"title":"Talking Photo API Overview","href":"/ai-tools-suite/talking-photo"},{"title":"Talking Avatar","href":"/ai-tools-suite/talking-avatar"},{"title":"LipSync","href":"/ai-tools-suite/lip-sync"},{"title":"Jarvis Moderator","href":"/ai-tools-suite/jarvis-moderator"},{"title":"AI Model","href":"/ai-tools-suite/aimodel"},{"title":"Webhook","href":"/ai-tools-suite/webhook"},{"title":"ErrorCode","href":"/ai-tools-suite/error-code"}]}]},{"anchor":"Overview","icon":"book-open-cover","pages":[{"title":"Overview","href":""}]},{"anchor":"Github","icon":"github","href":"https://github.com/AKOOL-Official"},{"anchor":"Postman","icon":"mailbox","color":{"light":"#FF6C37","dark":"#FF6C37"},"href":"https://www.postman.com/akoolai/team-workspace/collection/40971792-f9172546-2d7e-4b28-bb20-b86988f3ab1d?action=share\u0026creator=40971792"},{"anchor":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/cli"}]},{"anchor":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp-server"}]},{"anchor":"Blog","icon":"newspaper","href":"https://akool.com/blog"},{"anchor":"Change Logs","icon":"clock-rotate-left","pages":[{"title":"Change Logs","href":"/changelog"}]}]},"title":"Face Swap Pro - Akool open api documents","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}