A2E
  1. Start and Manage Face Swap Tasks
A2E
  • AI Avatar API
  • Get Tokens
    • Getting API Tokens (2025 version)
  • TTS and Voice Clone
    • List Public TTS Options
      POST
    • List Public TTS Options
      GET
    • List Voice Clone Options
      GET
    • Train TTS Model of The User's Voice (Voice Clone)
      POST
    • List Ongoing Voice Clone Tasks
      GET
    • Generate TTS Audio (Text-to-Speech)
      POST
    • Get Details of a Voice
      GET
    • Delete a User Voice
      DELETE
  • Generate Avatar Videos
    • Generate AI Avatar Videos
      POST
    • List of Result Videos
      POST
    • List of Result Videos
      GET
    • List One or All Avatars
      POST
    • List One or All Avatars
      GET
    • Obtain the Status of One Avatar Video Task
      POST
    • Obtain the List of Personalized Lip-Sync Models
      GET
    • Delete or Cancel a Video
      DELETE
    • Auto Language Detect
      POST
    • Auto Swith to Public Computing Pool
      POST
  • Create Avatars and Train Lip-sync Models
    • Create A Custom Avatar by a Video or an Image
    • Train a Personalized Lip-sync Model (Optional) a.k.a. Continue Training 💠
    • Remove A Customized Avatar
    • Get Status of All Tasks
    • Get All Ongoing "Training" Tasks
    • Status of One Task
    • Clone Voice from a Video
  • Background Matting and Replacement
    • Obtain the List of Background Images
    • Add Custom Background Image
    • Delete Custom Image
  • Face Swap
    • Manage Face Swap Resource
      • Add Face Swap Image
      • Get Records of Face Swap Images
      • Delete User Face Swap Image
    • Quickly Preview Face Swap
      • Add User Face Swap Preview
      • Get Status of Face Swap Preview Process
    • Start and Manage Face Swap Tasks
      • Start a Face Swap Task
        POST
      • Get Status of Face Swap Task
        GET
      • Get Face Swap Task Records
        GET
      • Get Details of Face Swap
        GET
      • Delete Record
        DELETE
  • AI Dubbing
    • Start dubbing
    • List Dubbing Tasks
    • List All Processing Dubbing Tasks
    • Get Details
    • Delete Record
  • Image to Video
    • Start Image-to-Video
    • Check Status of One Task
    • List Status of All Tasks
    • Delete Record
  • Caption Removal
    • Start Caption Removal
    • Get Records of All Tasks
    • Get Status of All Tasks in Processing
    • Get Details of One Task
    • Delete a Task
  • Streaming Avatar
    • Get All avatars
    • Get a Streaming Avatar Token
    • Set QA Context
    • Get QA Context
    • Ask a Question to the Avatar
    • Let the Avatar Speak Directly
    • Leave the Room
  • Miscellaneous
    • Add a User
    • Get User Remaining Credits
    • Exchange Diamonds
    • List Available Languages
    • Save URL to A2E's storage
    • Add Watermark to Video or Image
  • Text to Image
    • Start Text-to-Image
    • List Tasks of Text-to-Image Tasks
    • Get Details of One Task
    • Delete Record
    • Quick Add Avarar
  • AI Outfit and Product Holding
    • Start AI Outfit or Product Holding
    • List Tasks of AI Outfit or Product Holding Tasks
    • Get Details of One Task
    • Delete Record
  • Talking Photo
    • Start a Task
    • List Tasks
    • Get Task Detail
    • Delete Task
  1. Start and Manage Face Swap Tasks

Start a Face Swap Task

Global Server
https://video.a2e.ai
Global Server
https://video.a2e.ai
POST
/api/v1/userFaceSwapTask/add
This API endpoint allows you to add a user face swap task by providing the name, face URL, and video URL.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
name
string 
required
The name of the user face swap task
face_url
string 
required
The URL of the face image to be used for swapping. Provide this or video_url.
video_url
string 
required
The URL of the video for face swapping. Provide this or face_url.
Example
{
    "name":"xxxx",
    "face_url":"https://dh24as48lv9ce.cloudfront.net/adam2eve/beta/face_swap/ab2fca41-90e5-41a6-aa66-08a960b035e4.jpg",
    "video_url":"https://dh24as48lv9ce.cloudfront.net/pbs_lite/stable/customer/645888fc89897e30c57e31f0/clipVideo/665d718eb8f6a5ee678aa392/1717400057881.mp4"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://video.a2e.ai/api/v1/userFaceSwapTask/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name":"xxxx",
    "face_url":"https://dh24as48lv9ce.cloudfront.net/adam2eve/beta/face_swap/ab2fca41-90e5-41a6-aa66-08a960b035e4.jpg",
    "video_url":"https://dh24as48lv9ce.cloudfront.net/pbs_lite/stable/customer/645888fc89897e30c57e31f0/clipVideo/665d718eb8f6a5ee678aa392/1717400057881.mp4"
}'

Responses

🟢200add
application/json
Body
code
integer 
required
0 is OK
data
object 
required
name
string 
required
video_url
string 
required
The URL of the video
duration
integer 
required
face_url
string 
required
The URL of the face image
current_status
string 
required
result_url
string 
required
error_code
string 
required
faild_message
string 
required
_id
string 
required
createdAt
string 
required
updatedAt
string 
required
Example
{
    "code": 0,
    "data": {
        "name": "xxxx",
        "video_url": "https://dh24as48lv9ce.cloudfront.net/pbs_lite/stable/customer/645888fc89897e30c57e31f0/clipVideo/665d718eb8f6a5ee678aa392/1717400057881.mp4",
        "duration": 6,
        "face_url": "https://dh24as48lv9ce.cloudfront.net/adam2eve/beta/face_swap/ab2fca41-90e5-41a6-aa66-08a960b035e4.jpg",
        "current_status": "initialized",
        "result_url": "",
        "error_code": "",
        "faild_message": "",
        "_id": "6674f1765699df7e9d25311a",
        "createdAt": "2024-06-21T03:20:22.436Z",
        "updatedAt": "2024-06-21T03:20:22.436Z"
    }
}
Modified at 2025-07-23 05:06:28
Previous
Get Status of Face Swap Preview Process
Next
Get Status of Face Swap Task
Built with