A2E
  1. Background Matting and Replacement
A2E
  • AI Avatar API
  • Get Tokens
    • Obtain Login Token
      POST
    • Get API token
      POST
    • Delete API token
      POST
    • List api tokens
      GET
    • Getting API Tokens (2025 version)
      GET
  • TTS and Voice Clone
    • List Public TTS Options
      POST
    • 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 One or All Avatars
      POST
    • 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
      POST
    • Train a Personalized Lip-sync Model (Optional) a.k.a. Continue Training 💠
      POST
    • Remove A Customized Avatar
      POST
    • Get Status of All Tasks
      GET
    • Get All Ongoing "Training" Tasks
      GET
    • Status of One Task
      GET
    • Clone Voice from a Video
      POST
  • Background Matting and Replacement
    • Obtain the List of Background Images
      POST
    • Add Custom Background Image
      POST
    • Delete Custom Image
      POST
  • 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
    • Face Swap Tasks
      • Add User Face Swap Task
      • Get Status of Face Swap Task
      • Get Face Swap Task Records
      • Get Details of Face Swap
      • Delete Record
  • 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 Coins
    • Exchange Diamonds
    • List Available Languages
    • Save URL to A2E's storage
  1. Background Matting and Replacement

Add Custom Background Image

Global Server
Global Server
POST
/api/v1/custom_back/add
Add custom background image. This only works if your avatar support background swap.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
img_url
string 
required
link to the image. Make sure the link is accessible by the public
Example
{
  "img_url": "https://xxx.s3.aws.com/xxxx"
}

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/custom_back/add' \
--header 'Content-Type: application/json' \
--data-raw '{"img_url":"https://xxx.s3.aws.com/xxxx"}'

Responses

🟢200add
application/json
Body
code
integer 
required
0 is OK
data
object 
required
_id
string 
required
id of the image
type
string 
required
Type of the image (custom)
url
string 
required
link to the image
createdAt
string 
required
Example
{
  "code": 0,
  "data": {
    "_id": "652644d3c94a53313c6f02cd",
    "type": "custom",
    "url": "https://d1tzkvq5ukphug.cloudfront.net/adam2eve/beta/face_swap/face__swap/184ed6d7-c3e6-4c6f-a76f-9e5d6070b10c.jpg",
    "createdAt": "2023-10-11T06:46:43.174Z"
  }
}
Modified at 2025-02-24 07:19:30
Previous
Obtain the List of Background Images
Next
Delete Custom Image
Built with