跳转至

使用模板的批量视频请求

本 API 指南概述了使用模板生成批量请求。


模板简化了生成批量请求的过程。 为了减少创建视频时重复输入数据的需要,你可以使用 创建模板 API 创建模板。 建立模板后,你可以多次使用此模板来有效地生成批量请求。 要了解什么是批量请求,请阅读 创建批量请求 API 介绍 🦊

快速入门

让我们深入了解如何使用批量模板创建批量请求。 ## 从模板创建批量请求 你可以使用从 模板列表 API创建模板 API 获得的 'id' 作为 'template_id'。 提供此 'template_id' 以及"video_name"以创建批量请求。 在响应中,你将收到有关成功视频数量和失败视频数量的详细信息。使用响应中的 'id' 来使用 批量状态 API 检查批量请求的状态。配置是可选的,如果你发送任何配置,它将在模板中更新,并且视频将根据新模板生成。请注意,如果你提供 configurations,你还必须指定 scene_number 字段。

  • 'id':批量请求的标识符。
  • 'successful_requests_count':成功发送处理的视频数量。
  • 'failed_requests_count':处理失败的视频数量。
curl --request POST  \
     --url 'https://api.immersive-fox.com/v1/bulk_requests/generate_video_from_template/'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'  \
     --data { \
                "template_id": 45, \
                "csv_id": 123, \
                "configurations": [ \
                    { \
                        "scene_number": 1, \
                        "audio_text": "Hi, My name is {{First Name}}", \
                        "avatar": 102, \
                        "avatar_size": 76, \
                        "background_color": "#ffffff", \
                        "background_music_is_personalized": "system", \
                        "background_music_volume": 0.1, \
                        "frame_height": 1080, \
                        "frame_width": 1920, \
                        "is_personalized_audio": false, \
                        "scene_transition": "none", \
                        "audio_id": 2, \
                        "audio_service": "google_audio", \
                        "user_voice_speed": 1, \
                        "x_position": 0.604931, \
                        "y_position": 0.43101 \
                    } \
                ] \
            }
{
    "id": 108,
    "message": "Requests Created",
    "successful_requests_count": 3,
    "failed_requests_count": 0,
    "failed_requests": []
}