头像创建

本 API 指南概述了如何在我们的平台上创建头像。

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

快速入门

让我们深入了解如何在我们的平台上创建即时和高级头像。

创建即时头像

即时头像是根据您提供的照片快速生成的，提供了一种快速创建头像的方法。要创建即时头像，您必须提供符合这些指南的照片，因为头像的质量完全取决于所提供的照片。向 API 发出请求以即时创建头像。接受的图像格式包括'png'和'jpeg'。使用示例请求中提供的键将文件和其他数据作为 multipart/form-data 发送。在响应中，'id' 是您将用于批量视频请求的关键元素。'thumbnail' 提供新创建的头像的预览，允许您在使用前查看它。响应中还将包含其他详细信息，例如 'name'、'gender' 和 'user'。

使用头像状态 api 检查头像状态。

请求响应

curl --request POST \
     --url '<https://api.immersive-fox.com/v1/avatar_generation/create_instant_avatar/>' \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: multipart/form-data' \
      -F 'file=@my_image.png' \
      -F 'name=John' \
      -F 'gender=Male' \
      -F 'remove_background=false'

{
    "id": 839,
    "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
    "name": "Smith",
    "gender": "Male",
    "user": 31,
    "remove_background": false,
    "based_on": "Photo",
    "has_hand_wave": false
    "generation_time": 20
}

创建高级头像

高级头像是根据视频创建的，可呈现更真实、更细致的形象。要使用我们的 API 生成高级头像，请按以下步骤操作：

请求预签名 URL： 首先，通过指定要上传的视频的文件扩展名（例如 .mp4），从预签名 URL 生成端点请求预签名 URL 和相应的视频文件名。响应将提供两个预签名 URL（一个用于无声视频，一个用于有声视频），允许直接上传。此外，响应将包括两个视频的文件名，必须在下一步中提交这些文件名才能生成高级头像。

请求响应

curl --request POST  \
    --url 'https://api.immersive-fox.com/v1/avatar_generation/premium_avatar_presigned_urls/'  \
    --header 'X-Api-Key: <your-api-key>' \
    --header 'Content-Type: application/json'  \
    --header 'Content-Type: multipart/form-data' \
    -F 'speaking_video_extention=.mp4' \
    -F 'silent_video_extention=.mp4'

{
"silent_video_data": {
    "presigned_url": "https://premium-avatar-videos.s3.amazonaws.com/silent_videos/31_6f72a1900fd64969ab9f8df465f9e92c.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6E6ARAOX65ONAQYP%2F20241002%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20241002T221000Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=72058a2c206ba63726eeda2e88266575c046fa0625f9af1c366b4b9bf921b3ef",
    "file_name": "31_6f72a1900fd64969ab9f8df465f9e92c.mp4"
},
"speaking_video_data": {
    "presigned_url": "https://premium-avatar-videos.s3.amazonaws.com/speaking_videos/31_1e4eb799a3b84639a11c929a6729a1be.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6E6ARAOX65ONAQYP%2F20241002%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20241002T221000Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=58e84ccd7d702b64b3400479f27b417f551317ca96afce3e923ac18d9db28bce",
    "file_name": "31_1e4eb799a3b84639a11c929a6729a1be.mp4"
}
}

使用预签名 URL 上传视频：要生成高级头像，您必须上传一段会说话的视频，而无声视频则是可选的，以提高头像的质量。请确保两个视频都遵循提供的指南。

使用 PUT 方法和您在上一步中获得的 'presigned_url'，有效期为 30 分钟。视频文件应在此时间范围内作为二进制数据直接上传到 URL。

请求响应

curl --request PUT  \
    --url 'https://premium-avatar-videos.s3.amazonaws.com/speaking_videos/{file_name}?<presigned_url_parameters>'  \
    --header 'X-Api-Key: <your-api-key>' \
    --header 'Content-Type: video/mp4'  \
    --data-binary '@speaking_video.mp4'

{
}

请求响应

curl --request PUT  \
    --url 'https://premium-avatar-videos.s3.amazonaws.com/silent_videos/{file_name}?<presigned_url_parameters>'  \
    --header 'X-Api-Key: <your-api-key>' \
    --header 'Content-Type: video/mp4'  \
    --data-binary '@silent_video.mp4'

{
}

发送头像创建请求：上传视频后，使用预签名 URL 请求中获取的'file_name'生成高级头像。响应中会包含新建高级头像的'id'，用于后续的批量视频请求。此外，响应中还会提供头像预览的'缩略图'，以及'生成时间'、'姓名'、'性别'等详细信息。

使用头像状态 api 查看头像状态。

请求请求

curl --request POST  \
    --url 'https://api.immersive-fox.com/v1/avatar_generation/create_premium_avatar/'  \
    --header 'X-Api-Key: <your-api-key>' \
    --header 'Content-Type: application/json'  \
    --header 'Content-Type: form-data' \
    -F 'avatar_name=John' \
    -F 'gender=Male' \
    -F 'remove_background=false' \
    -F 'silent_video_name=31_6f72a1900fd64969ab9f8df465f9e92c.mp4'  \
    -F 'speaking_video_name=31_1e4eb799a3b84639a11c929a6729a1be.mp4'

{
    "id": 840,
    "thumbnail": "https://storage.googleapis.com/my_bucket_name/avatar_thumbnail/my_thumbnail.png",
    "name": "John",
    "gender": "Male",
    "user": 31,
    "remove_background": true,
    "based_on": "Video",
    "has_hand_wave": false
    "generation_time": 24 
}