Domain Name

https://api.topview.ai

Authorization

TOPVIEW_API_KEY: Currently, it needs to be applied offline. Later, you can apply for it independently on the Topview official website.

Topview-Uid: Currently, you can double-click the avatar on the Topview page to copy it, or query it offline.

Authentication: Bearer + TOPVIEW_API_KEY

Example:

Upload

Step1: Obtain authorization
Upload - Get Upload Credential

Step2: Upload to S3

Step3: Check if the upload was successful
Upload - Get Upload Check

Response Code

Code	Message
200	Success
4000	Request parameter error
4001	Request data format does not match!
4002	Request digital signature does not match!
4003	Required parameter cannot be null
4004	Resource not found!
4005	Name duplicated
4006	Request refuse
4007	Exists unfinished task, please wait until the previous task is completed.
4100	Credit not enough
5000	Internal server error!
5001	Feign invoke error
5003	Server is busy, please try again later!
5004	I/O error occurred
5005	Unknown error occurred
6001	Security problem detect

Avatar Marketing Video

Submit Task:

Avatar Marketing Video - submit task

Query Task:

Avatar Marketing Video - query task

Note

If local materials are required for production, you need to call the Upload interface to upload them. After obtaining the fileId, then submit the task.

If only local materials are used for production (without using links), and all the materials are images, then the number of images needs to be greater than 10.

If other voice tones are needed, you can query Voice Query.

If an AI avatar is needed, you can query AiAvatar Query.

Script

Get Script Content

Avatar Marketing Video - script - list script content

Modify Script

Avatar Marketing Video - script - update script content

Video Avatar

1. Usage

See the Video Avatar API Usage.

2. Supported Interface:

Ethnicity list query

Ethnicity Query

Public Model Avatar Query

AiAvatar Query

Product Avatar

1. Supported interface

2. Replace Product Image Task

Submit Task

Product Avatar - Replace Product Image - submit task

Query Task

Product Avatar - Replace Product Image - query task

3. Image2Video Task

Submit Task

Product Avatar - Image2Video - submit task

Query Task

Product Avatar - Image2Video - query task

Note

The xxxFileId field of the Product Avatar - Replace Product Image - submit task interface requires you to first obtain a temporary file credential. Then, upload the file to S3. After a successful upload, set the fileId from the temporary credential to the xxxFileId field. For detailed steps, see Upload file.

The productReplaceResultKey field of the Product Avatar - image2Video - submit task interface must be the result-productReplaceResult-key key from the response data of the Product Avatar - Replace Product Image - query task. For example, if the response data from the Replace Product Image - query task is as follows, then the key would be 21f48762080b42f1b718ad722f92c.

{
    "code": "200",
    "message": "Success",
    "result": {
        "taskId": "176bd1a50ba8437db36af5eb8fd9e5ca",
        "taskStatus": "success",
        "productReplaceResult": [
            {
                "key": "21f48762080b42f1b718ad722f92c",
                "url": "https://aigc.s3.amazonaws.com/analyzed_video/video/21f48762080b42f1b718ad722f92cbb1/21f48762080b42f1b718ad722f92cbb1.jpg"
            }
        ]
    }
}

Product Anyshoot

1、Supported interface

Template List Query

Template List

Template Category Query

Template Category

2. Anyshoot Replace Product Image Task

Submit Task

Product AnyShoot - Replace Product Image - submit task

Query Task

Product AnyShoot - Replace Product Image - query task

Note：

The size of the productMaskFileId file must be consistent with the size of the productImageFileId file;

The size of the templateMaskFileId file must be consistent with the size of the templateImageFileId file;

productImageFileId、productMaskFileId、templateImageFileId、templateMaskFileId all require obtaining fileId through upload file;

If both 'templateId' and 'templateImageFileId' pass values, then the 'templateImageFileId' file will be used first.

Common Task

Image2Video

Submit Task

Common Task - image2Video - submit task

Query Task

Common Task - image2Video - query task

Video2AiAvatar

video conditions

resolution：360p ~ 4k

format：mp4, mov

duration：4s ~ 3min

size：< 100MB

Submit Task

Common Task - video2aiavatar - submit task

Query Task

Common Task - video2aiavatar - query task

Custom AiAvatar Query

AiAvatar Query【isCustom=true】

Delete Custom AiAvatar

Delete Custom Avatar

Voice

1、Voice Clone

submit task

Voice - Voice Clone - submit task

Note：

originVoiceFileId conditions

format：mp3, wav

size：< 10MB

The effective range of voiceSpeed is [0.8 ～ 1.2]

query task

Voice - Voice Clone - query task

2、text2voice

submit task

Voice - text2voice - submit task

Note：

The effective range of voiceSpeed is [0.8 ～ 1.2]

query task

Voice - text2voice - query task

3、Delete Custom Voice

Delete Custom Voice

Notice Url

Introduction

Step1: Validate the legality of the callback address check notice url through the interface check noticeUrl.

Step2: Add the noticeUrl field to the submit task interface to set the callback address.

Step3: The callback interface receives data. Topview Server will send the result data of the query task interface to ${noticeUrl}.

Step4: The callback interface returns data. The callback interface needs to return response data to the Topview Server.

Timing Diagram

NoticeBizType

bizType
SCRAPER
ZERO_SHOT_AVATAR
M2V_PREVIEW
M2V_EXPORT
M2V_SCRIPT
PRODUCT_AVATAR_REPLACE_PRODUCT_IMAGE
PRODUCT_AVATAR_IMAGE2VIDEO
PRODUCT_ANY_SHOOT
COMMON_TASK_IMAGE2VIDEO
COMMON_TASK_TEXT2VIDEO
COMMON_TASK_TEXT2IMAGE
COMMON_TASK_VIDEO2AIAVATAR
VOICE_CLONE
VOICE_TEXT2VOICE

For example

Step1: The noticeUrl is http://127.0.0.1:8080/notice. Assume that the check notice url is called to validate its legality.
Step2: Add noticeUrl to the Avatar Marketing Video - submit task API interface.

Step3: Assuming the query result for Avatar Marketing Video - query task is as follows:

{
    "code": "200",
    "message": "Success",
    "result": {
        "taskId": "0d3a303bfc1f4f0e9a287ba47dbbefbc",
        "status": "success",
        "errorMsg": null,
        "exportVideos": [
            {
                "scriptId": 0,
                "status": null,
                "title": null,
                "description": null,
                "videoUrl": null,
                "coverUrl": null,
                "videoDuration": null
            }
        ],
        "previewVideos": [
            {
                "scriptId": 0,
                "status": "success",
                "title": null,
                "description": null,
                "videoUrl": "https://aigc.s3.amazonaws.com/analyzed_video/task/export/487a84446461405088b751861d497dfd_topview.ai.mp4",
                "coverUrl": "https://aigc.s3.amazonaws.com/analyzed_video/task/export/487a84446461405088b751861d497dfd.jpg",
                "videoDuration": 36096000
            }
        ]
    }
}

Then the result received by the noticeUrl interface is:

Step4: At the same time, the callback interface returns response data.

API Document

Domain Name#

Authorization#

Upload#

Response Code#

Avatar Marketing Video#

Submit Task:#

Query Task:#

Script#

Get Script Content#

Modify Script#

Video Avatar#

1. Usage#

2. Supported Interface:#

Ethnicity list query#

Public Model Avatar Query#

Product Avatar#

1. Supported interface#

Ethnicity list query#

Public model avatar category query#

Public model avatar list query#

2. Replace Product Image Task#

Submit Task#

Query Task#

3. Image2Video Task#

Submit Task#

Query Task#

Product Anyshoot#

1、Supported interface#

Template List Query#

Template Category Query#

2. Anyshoot Replace Product Image Task#

Submit Task#

Query Task#

Common Task#

Image2Video#

Submit Task#

Query Task#

Video2AiAvatar#

Submit Task#

Query Task#

Custom AiAvatar Query#

Delete Custom AiAvatar#

Voice#

1、Voice Clone#

submit task#

query task#

2、text2voice#

submit task#

query task#

3、Delete Custom Voice#

Notice Url#

Introduction#

Timing Diagram#

NoticeBizType#

For example#

Domain Name

Authorization

Upload

Response Code

Avatar Marketing Video

Submit Task:

Query Task:

Script

Get Script Content

Modify Script

Video Avatar

1. Usage

2. Supported Interface:

Ethnicity list query

Public Model Avatar Query

Product Avatar

1. Supported interface

Ethnicity list query

Public model avatar category query

Public model avatar list query

2. Replace Product Image Task

Submit Task

Query Task

3. Image2Video Task

Submit Task

Query Task

Product Anyshoot

1、Supported interface

Template List Query

Template Category Query

2. Anyshoot Replace Product Image Task

Submit Task

Query Task

Common Task

Image2Video

Submit Task

Query Task

Video2AiAvatar

Submit Task

Query Task

Custom AiAvatar Query

Delete Custom AiAvatar

Voice

1、Voice Clone

submit task

query task

2、text2voice

submit task

query task

3、Delete Custom Voice

Notice Url

Introduction

Timing Diagram

NoticeBizType

For example