头像列表

本 API 指南概述了列出头像和检查头像状态的过程。

---

您可以查看所有默认头像和个性化头像的列表并检查它们的状态。使用头像 'id' 来监控进度，因为生成过程可能需要一些时间。准备就绪后，您可以使用这些头像生成视频，并通过个性化头像功能增强您的内容。 🦊

快速入门

让我们深入了解如何列出个性化和默认头像。

列出默认头像

此端点检索我们平台提供的所有默认头像。响应包含 'id'、'thumbnail'、'name' 和 'gender' 等字段，这些字段提供有关每个头像的相关详细信息。

您可以使用 'id' 来创建 批量模板 或 批量请求

请求回应

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/avatar/default_avatars/' \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: application/json'

[
    {
        "id": 131,
        "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
        "name": "Riley",
        "gender": "Male",
        "gesture_support": "no",
        "based_on": "Video",
        "has_hand_wave": false

    }
]

列出个性化头像

此端点检索您已创建的所有个性化头像。响应包含'id'、'thumbnail'、'name'和'gender'等字段，这些字段提供有关每个头像的相关详细信息。您可以使用'id'创建批量模板或批量请求

请求回应

    curl --request GET  \
         --url https://api.immersive-fox.com/v1/avatar/personalized_avatars/ \
         --header 'X-Api-Key: <your-api-key>'  \
         --header 'Content-Type: application/json'

[
    {
        "id": 131,
        "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
        "name": "Lucy",
        "gender": "Female",
        "gesture_support": "no",
        "based_on": "Video",
        "has_hand_wave": false
        "status": "Completed",
    }
]

获取个性化头像状态

此端点可让您在头像创建过程中检查其当前状态。通过提供特定头像的"id"，您将收到有关其"status"的详细信息。例如，如果您提供的"id"为 131，响应将指示头像是否已成功创建，并将"status"标记为"已完成"或其他相关更新。

请求回应

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/avatar/status/<avatar_id>' \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: application/json'

[
    {
        "id": 131,
        "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
        "name": "Lucy",
        "gender": "Female",
        "gesture_support": "no",
        "based_on": "Video",
        "has_hand_wave": false
        "status": "Completed",
    }
]