コンテンツにスキップ

テンプレートを使用した一括ビデオ リクエスト

この 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 \
                    } \
                ] \
            }

=== 「レスポンス」

```javascript
{
    "id": 108,
    "message": "Requests Created",
    "successful_requests_count": 3,
    "failed_requests_count": 0,
    "failed_requests": []
}
```