# A2E

## Docs
- [API for Realistic Avatar Lip-sync and Voice Clone](https://api.a2e.ai/ai-avatar-api-766435m0.md): API documents of A2E avatar

## API Docs
- Get Tokens [Obtain Login Token](https://api.a2e.ai/obtain-login-token-12138789e0.md): This API is now <b>deprecated</b> and will be removed in the future. Please use <a href="https://video.a2e.ai/a2e/token">API Token</a> tab in the dropdown menu of the upper right corner of the web UI to get your ``API token``.
- Get Tokens [Get API token](https://api.a2e.ai/get-api-token-12138790e0.md): This API is now <b>deprecated</b> and will be removed in the future. Please use <a href="https://video.a2e.ai/a2e/token">API Token</a> tab in the dropdown menu of the upper right corner of the web UI to get your API token.
- Get Tokens [Delete API token](https://api.a2e.ai/delete-api-token-12138791e0.md): This API is now deprecated and will be removed in the future. Please use <a href="https://video.a2e.ai/a2e/token">API Token</a> tab in the dropdown menu of the upper right corner of the web UI to delete your API tokens.
- Get Tokens [List api tokens](https://api.a2e.ai/list-api-tokens-12138792e0.md): This API is now <b>deprecated</b> and will be removed in the future. Please use <a href="https://video.a2e.ai/a2e/token">API Token</a> tab in the dropdown menu of the upper right corner of the web UI to list your API tokens.
- Get Tokens [Getting API Tokens (2025 version)](https://api.a2e.ai/getting-api-tokens-2025-version-13182399e0.md): Log in to your web UI and click on your name in the top-right corner. From the dropdown menu, select the “API Token” section. You can manage your tokens directly within the web UI.
- TTS and Voice Clone [List Public TTS Options](https://api.a2e.ai/list-public-tts-options-12138795e0.md): Obtain the list of available TTS voices.
- TTS and Voice Clone [List Voice Clone Options](https://api.a2e.ai/list-voice-clone-options-12138810e0.md): This endpoint retrieves completed records for user voice clone training tasks from the server.
- TTS and Voice Clone [Train TTS Model of The User's Voice (Voice Clone)](https://api.a2e.ai/train-tts-model-of-the-users-voice-voice-clone-12138808e0.md): This endpoint allows to submit a POST request to initiate the training of a user's voice. The result of the training enables the TTS capability of the user's voice.
- TTS and Voice Clone [List Ongoing Voice Clone Tasks](https://api.a2e.ai/list-ongoing-voice-clone-tasks-12138809e0.md): This endpoint retrieves the status of the training process of user voice clone. The request does not contain a request body.
- TTS and Voice Clone [Generate TTS Audio (Text-to-Speech)](https://api.a2e.ai/generate-tts-audio-text-to-speech-12138799e0.md): If you want to use our TTS engine to generate an audio file and use it later for the "create" method for video synthesis, use this API.
- TTS and Voice Clone [Get Details of a Voice](https://api.a2e.ai/get-details-of-a-voice-12138811e0.md): This endpoint retrieves the details of a specific user voice by its ID.  
- TTS and Voice Clone [Delete a User Voice](https://api.a2e.ai/delete-a-user-voice-12138812e0.md): This HTTP DELETE request is used to delete a specific user voice with the provided ID.  
- Generate Avatar Videos [Generate AI Avatar Videos](https://api.a2e.ai/generate-ai-avatar-videos-12138800e0.md): Quality of the lip-sync: depending on whether you choose to “train a personalized avatar” (in the <b>Add Avatar </b> and  <b>Train Lip-sync</b> section), the system will automatically apply either the universal lip-sync model or the dedicated trained lip-sync model for your avatar. If you skip “train a personalized avatar,” the lip-sync results for your avatar will be less realistic compared to using a dedicated lip-sync model trained with your avatar’s video.
- Generate Avatar Videos [List of Result Videos](https://api.a2e.ai/list-of-result-videos-12138801e0.md): Get all the details of all your submitted video synthesis tasks. Since the results are so many, we return your results by pages.
- Generate Avatar Videos [List One or All Avatars](https://api.a2e.ai/list-one-or-all-avatars-12138793e0.md): Return all the avatars that are uploaded by users and provided by the system.
- Generate Avatar Videos [Obtain the Status of One Avatar Video Task](https://api.a2e.ai/obtain-the-status-of-one-avatar-video-task-12138802e0.md): Get the status of a specific video task.
- Generate Avatar Videos [Obtain the List of Personalized Lip-Sync Models](https://api.a2e.ai/obtain-the-list-of-personalized-lip-sync-models-12138803e0.md): Previously useful as the param of video/wl_model. Now deprecated.
- Generate Avatar Videos [Delete or Cancel a Video](https://api.a2e.ai/delete-or-cancel-a-video-12138804e0.md): This HTTP DELETE request is used to delete or cancel a specific video with the provided ID. If the video has not been processed. It will be canceled and It won't be processed in the future. If the video is pending or being processed, it will keep running and finish process. But you will not see the video in your results.
- Generate Avatar Videos [Auto Language Detect](https://api.a2e.ai/auto-language-detect-12138805e0.md): This endpoint is used to Detect the text language.
- Generate Avatar Videos [Auto Swith to Public Computing Pool](https://api.a2e.ai/auto-swith-to-public-computing-pool-12980943e0.md): Only clients with dedicated lines can access this endpoint. This is a switch applying to your entire account. When set to true, videos generation requests created by``/api/v1/video/generate`` will automatically be sent to the public computing pool if your dedicated lines are all being used.
- Create Avatars and Train Lip-sync Models [Create A Custom Avatar by a Video or an Image](https://api.a2e.ai/create-a-custom-avatar-by-a-video-or-an-image-12138813e0.md): This API is equivalent to "⚡️Instant Avatar" in our website.
- Create Avatars and Train Lip-sync Models [Train a Personalized Lip-sync Model (Optional) a.k.a. Continue Training 💠](https://api.a2e.ai/train-a-personalized-lip-sync-model-optional-a-k-a-continue-training-12138814e0.md): This endpoint is used to continue the training for a user video twin. It is equivalent to "Studio Avatar💠" in our website.
- Create Avatars and Train Lip-sync Models [Remove A Customized Avatar](https://api.a2e.ai/remove-a-customized-avatar-12138815e0.md): This endpoint allows users to remove a user video twin by making an HTTP POST request to the specified URL.
- Create Avatars and Train Lip-sync Models [Get Status of All Tasks](https://api.a2e.ai/get-status-of-all-tasks-12138816e0.md): Get all the records of the user's video avatar training tasks.
- Create Avatars and Train Lip-sync Models [Get All Ongoing "Training" Tasks](https://api.a2e.ai/get-all-ongoing-training-tasks-12138817e0.md): Retrieve the currently training tasks.
- Create Avatars and Train Lip-sync Models [Status of One Task](https://api.a2e.ai/status-of-one-task-12138818e0.md): This endpoint retrieves the details of a specific user video twin by its ID.  
- Create Avatars and Train Lip-sync Models [Clone Voice from a Video](https://api.a2e.ai/clone-voice-from-a-video-12138819e0.md): This endpoint is used to clone the voice from an avatar video. It is equivalent to "Voice Clone" in the "Add avatar" tab in our website.
- Background Matting and Replacement [Obtain the List of Background Images](https://api.a2e.ai/obtain-the-list-of-background-images-12138796e0.md): Return user uploaded and system provided background images
- Background Matting and Replacement [Add Custom Background Image](https://api.a2e.ai/add-custom-background-image-12138797e0.md): Add custom background image. This only works if your avatar support background swap.
- Background Matting and Replacement [Delete Custom Image](https://api.a2e.ai/delete-custom-image-12138798e0.md): Delete custom images from the database.
- Face Swap > Manage Face Swap Resource [Add Face Swap Image](https://api.a2e.ai/add-face-swap-image-12138820e0.md): The `POST` request to `/api/v1/userFaceSwapImage/add` endpoint is used to add a user's face swap image.
- Face Swap > Manage Face Swap Resource [Get Records of Face Swap Images](https://api.a2e.ai/get-records-of-face-swap-images-12138821e0.md): The response contains an array of records, where each record includes the face URL, deletion status, unique ID, user ID, creation timestamp, update timestamp, and version.
- Face Swap > Manage Face Swap Resource [Delete User Face Swap Image](https://api.a2e.ai/delete-user-face-swap-image-12138822e0.md): This endpoint is used to delete a specific user face swap image.
- Face Swap > Quickly Preview Face Swap [Add User Face Swap Preview](https://api.a2e.ai/add-user-face-swap-preview-12138823e0.md): This endpoint allows you to add a user face swap preview by providing the URL of the face and the video.
- Face Swap > Quickly Preview Face Swap [Get Status of Face Swap Preview Process](https://api.a2e.ai/get-status-of-face-swap-preview-process-12138824e0.md): This endpoint retrieves the status of a user face swap preview by providing the unique identifier (_id) as a query parameter in the URL.
- Face Swap > Face Swap Tasks [Add User Face Swap Task](https://api.a2e.ai/add-user-face-swap-task-12138825e0.md): This API endpoint allows you to add a user face swap task by providing the name, face URL, and video URL.
- Face Swap > Face Swap Tasks [Get Status of Face Swap Task](https://api.a2e.ai/get-status-of-face-swap-task-12138826e0.md): This endpoint makes an HTTP GET request to retrieve the status of a user's face swap task. The request does not require any parameters in the request body.
- Face Swap > Face Swap Tasks [Get Face Swap Task Records](https://api.a2e.ai/get-face-swap-task-records-12138827e0.md): This endpoint retrieves a list of user face swap task records.
- Face Swap > Face Swap Tasks [Get Details of Face Swap](https://api.a2e.ai/get-details-of-face-swap-12138828e0.md): This endpoint retrieves the details of a specific user face swap task by its ID.  
- Face Swap > Face Swap Tasks [Delete Record](https://api.a2e.ai/delete-record-12138829e0.md): This HTTP DELETE request is used to delete a specific record with the provided ID.
- AI Dubbing [Start dubbing](https://api.a2e.ai/start-dubbing-12138830e0.md): Convert the audio in one language to another. The input audio is provided as an audio URL, or a video URL (the audio will then be extracted from the video file).
- AI Dubbing [List Dubbing Tasks](https://api.a2e.ai/list-dubbing-tasks-12138831e0.md): This endpoint retrieves all dubbing records with pagination.
- AI Dubbing [List All Processing Dubbing Tasks](https://api.a2e.ai/list-all-processing-dubbing-tasks-12138832e0.md): Retrieve the current status of a dubbing task (e.g. sent or pending or processing).
- AI Dubbing [Get Details](https://api.a2e.ai/get-details-12138833e0.md): This endpoint retrieves the details of a specific dubbing by its ID.   _id (string): The unique identifier of the dubbing record. 
- AI Dubbing [Delete Record](https://api.a2e.ai/delete-record-12138834e0.md): This HTTP DELETE request is used to delete a specific record with the provided ID. _id (string): The unique identifier of the dubbing record. 
- Image to Video [Start Image-to-Video](https://api.a2e.ai/start-image-to-video-14770503e0.md): Initiate an image-to-video task. Our model produces a 5 seconds long high-quality 720p videos. Our image-to-video model is specifically optimized to generate highly detailed facial features. Under normal circumstances, a task will be completed within 10 minutes, provided there is no queue.
- Image to Video [Check Status of One Task](https://api.a2e.ai/check-status-of-one-task-14771261e0.md): 
- Image to Video [List Status of All Tasks](https://api.a2e.ai/list-status-of-all-tasks-14771127e0.md): This API endpoint is useful when you are developing an APP and you want to show all i2v tasks to your users. If you only want to check the status of a specific task, please use ``/api/v1/userImage2Video/{_id}``
- Image to Video [Delete Record](https://api.a2e.ai/delete-record-14772418e0.md): Delete the record from the database, so it will be appear in the result of ``/api/v1/userImage2Video/allRecords``. However, this will stop the ongoing process. It will refund your coins either.
- Caption Removal [Start Caption Removal](https://api.a2e.ai/start-caption-removal-12138835e0.md): Remove texts from the frames of a video. This API uses OCR to detect texts in every frame, and performs video inpainting to remove the text. 
- Caption Removal [Get Records of All Tasks](https://api.a2e.ai/get-records-of-all-tasks-12138836e0.md): This endpoint retrieves records all caption removal tasks with pagination.
- Caption Removal [Get Status of All Tasks in Processing](https://api.a2e.ai/get-status-of-all-tasks-in-processing-12138837e0.md): Retrieve the status of a caption removal task in processing (e.g. sent or pending or processing).
- Caption Removal [Get Details of One Task](https://api.a2e.ai/get-details-of-one-task-12138838e0.md): This endpoint retrieves the details of a specific subtitle removal task by its ID.   _id (string): The unique identifier of the caption removal record. 
- Caption Removal [Delete a Task](https://api.a2e.ai/delete-a-task-12138839e0.md): This HTTP DELETE request is used to delete a specific task with the provided ID. If the task has not been processed. It won't be processed in the future. If the task is pending or being processed, it will wait and finish process. But you will not be able to see the task information.
- Streaming Avatar [Get All avatars](https://api.a2e.ai/get-all-avatars-12792583e0.md): Get all streaming avatars and select one of them to generate video stream.
- Streaming Avatar [Get a Streaming Avatar Token](https://api.a2e.ai/get-a-streaming-avatar-token-12713815e0.md): Our AI powering the lip motion and body movements of the avatar operates on our computing clusters. The generated video stream is delivered to the end user using <a href="https://www.agora.io/">Agora</a> Real-Time Communication (RTC) technology.
- Streaming Avatar [Set QA Context](https://api.a2e.ai/set-qa-context-12731082e0.md): By default, we use a prompt to set the avatar’s knowledge base. The length of the QA context is limited to 5,000 characters. Once you use this API to set the QA context, you can use the <b>Ask</b> ``/api/v1/streaming-avatar/ask`` functionality to ask questions, and the avatar will respond based on the context you have provided.
- Streaming Avatar [Get QA Context](https://api.a2e.ai/get-qa-context-12731086e0.md): Get the current QA context. The context is set by you using ``/api/v1/streaming-avatar/set-qa-context``
- Streaming Avatar [Ask a Question to the Avatar](https://api.a2e.ai/ask-a-question-to-the-avatar-12731097e0.md): You need to set the context for QA by using ``/api/v1/streaming-avatar/set-qa-context``. We provide basic QA function by prompt engineering. For more advanced QA capabilities, such as Retrieval-Augmented Generation (RAG), you will need to implement the QA logic yourself. In this case, you can use the <b>Speak</b> ``/api/v1/streaming-avatar/speak`` API to directly control what the avatar says.
- Streaming Avatar [Let the Avatar Speak Directly](https://api.a2e.ai/let-the-avatar-speak-directly-12731098e0.md): Let the avatar speak something immediately.
- Streaming Avatar [Leave the Room](https://api.a2e.ai/leave-the-room-12731099e0.md): You must explicitly call this API to stop the deduction of coins, so that our system knows the user leaves the Agora room and releases the resource. Otherwise, our system will not release the resources allocated for you, and it will continue to deduct coins from your account.
- Miscellaneous [Add a User](https://api.a2e.ai/add-a-user-12138840e0.md): For security reasons, this API is disabled by default. Please email: [contact@a2e.ai](https://mailto:contact@a2e.ai) to discuss how to enable this API for your application.
- Miscellaneous [Get User Remaining Credits](https://api.a2e.ai/get-user-remaining-credits-12138806e0.md): This endpoint retrieves the remaining credits of a user.
- Miscellaneous [Exchange Diamonds](https://api.a2e.ai/exchange-diamonds-12138807e0.md): *Deprecated* The concepts of diamonds are completed removed. Every operation only consumes credits.
- Miscellaneous [List Available Languages](https://api.a2e.ai/list-available-languages-12138794e0.md): This is useful if you develop a UI for your users to select languages. You can get the language information in English or Chinese.
- Miscellaneous [Save URL to A2E's storage](https://api.a2e.ai/save-url-to-a2es-storage-14367827e0.md): Transfer and Store External Link Content in A2E’s Object Storage