Topview-api-English version
    Topview-api-English version
    • API Document
    • Avatar Marketing Video
      • script
        • List script content
        • Update script content
      • Submit task
        POST
      • Query task
        GET
      • Export
        POST
    • Video Avatar
      • submit task
        POST
      • query task
        GET
    • Scraper
      • submit scraper task
        POST
      • query scraper task
        GET
    • Upload
      • Get Upload Credential
        GET
      • Get Upload Check
        GET
    • Product Avatar
      • Replace Product Image
        • submit task
        • query task
      • Image2Video
        • submit task
        • query task
      • Category Query
        GET
      • Public product avatar Query
        GET
    • Common Task
      • image2Video
        • submit task
        • query task
    • Product AnyShoot
      • Replace Product Image
        • submit task
        • query task
      • Template Category
        GET
      • Template List
        GET
    • Caption List
      GET
    • Voice Query
      GET
    • AiAvatar Query
      GET
    • check notice url
      POST
    • Ethnicity Query
      GET

    API Document

    Domain Name#

    https://api.topview.ai

    Authorization#

    1.
    TOPVIEW_API_KEY: Currently, it needs to be applied offline. Later, you can apply for it independently on the Topview official website.
    2.
    Topview-Uid: Currently, you can double-click the avatar on the Topview page to copy it, or query it offline.
    3.
    Authentication: Bearer + TOPVIEW_API_KEY
    4.
    Example:

    Upload#

    1.
    Step1: Obtain authorization
    Upload - Get Upload Credential
    2.
    Step2: Upload to S3
    3.
    Step3: Check if the upload was successful
    Upload - Get Upload Check

    Avatar Marketing Video#

    Submit Task:#

    Avatar Marketing Video - submit task

    Query Task:#

    Avatar Marketing Video - query task
    Note
    1.
    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.
    2.
    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.
    3.
    If other voice tones are needed, you can query Voice Query.
    4.
    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#

    Submit Task:#

    Video Avatar - submit task

    Query Task:#

    Video Avatar - query task

    Product Avatar#

    1. Supported interface#

    Ethnicity list query#

    Ethnicity Query

    Public model avatar category query#

    Category Query

    Public model avatar list query#

    Public product avatar Query

    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
    1.
    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.
    2.
    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：
    1.
    The size of the productMaskFileId file must be consistent with the size of the productImageFileId file;
    2.
    The size of the templateMaskFileId file must be consistent with the size of the templateImageFileId file;
    3.
    productImageFileId、productMaskFileId、templateImageFileId、templateMaskFileId all require obtaining fileId through upload file;
    4.
    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

    Notice Url#

    1.
    Step1: Validate the legality of the callback address check notice url through the interface check noticeUrl.
    2.
    Step2: Add the noticeUrl field to the submit task interface to set the callback address.
    3.
    Step3: The callback interface receives data. Topview Server will send the result data of the query task interface to ${noticeUrl}.
    4.
    Step4: The callback interface returns data. The callback interface needs to return response data to the Topview Server.
    Timing Diagram
    image.png
    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.
    Modified at 2025-06-11 08:27:07
    Next
    List script content
    Built with