一括ビデオ リクエスト
この API ガイドでは、一括リクエスト生成の概要を説明します。
一括ビデオリクエスト 一括リクエストを使用すると、ユーザー固有のデータを含む CSV ファイルを使用して、一度に複数のパーソナライズされたビデオファイルを生成できます。各オーディオを個別に作成する代わりに、名前や会社の詳細などのさまざまなフィールドを CSV に入力すると、システムが各エントリに対してカスタマイズされたオーディオを自動的に生成します。 🦊 複数のユーザー用にパーソナライズされたオーディオファイルを作成するとします。 CSV ファイルに次のデータが含まれています。
| 名 | 会社名 |
|---|---|
| John | Acme Corp |
| Jane | Beta Ltd |
これで、音声テキストで、サポートされているマクロを次のように使用できます:
「こんにちは {{First Name}}、{{Company Name}} へようこそ!」
一括リクエストが処理されると、マクロは CSV の値に置き換えられます。生成される音声は次のようになります:
- 「こんにちは John Smith、Acme Corp へようこそ!」
- 「こんにちは Jane Doe、Beta Ltd へようこそ!」
これにより、CSV 内の各ユーザーに対してカスタマイズされた音声ファイルを作成できるため、一括リクエストが効率的かつパーソナライズされたものになります。
クイック スタート
カスタム構成を使用して一括リクエストを作成する方法を詳しく見ていきましょう。
一括リクエストの作成
一括リクエストを作成するには、次の API リクエストを使用します。これにより、音声テキスト、アバター、背景など、さまざまな設定を定義して一括リクエストを生成できます。ニーズに合わせてパラメータをカスタマイズします。一括テンプレートがある場合、それを使用して一括リクエストを作成するには、一括テンプレート作成 API を使用します。
'audio_id' と 'audio_service' は オーディオ リスト API から取得でき、"csv_id" は csv リスト API から取得できます。
'audio_text' 内で '{{}}' 形式のマクロを使用できます。これは、指定した CSV ファイルの値に動的に置き換えられます。たとえば、テキストに '{{First Name}}' を含めると、CSV 内の対応するエントリごとに "John" や "Smith" などの名前に置き換えられ、リスト内の各ビデオにパーソナライズされたオーディオが作成されます。1 つのリクエストで最大 20 個のテンプレート変数がサポートされます。これらの変数の数と名前がテキストと CSV ファイルで完全に一致していることを確認してください。テンプレート変数のテキストの大文字と小文字は区別されません。 CSV にテンプレート変数が不足している場合は、エラーが返されます。
応答では、成功したビデオの数と失敗したビデオの数の詳細が返されます。 応答の 'id' を使用して、一括ステータス API を使用して一括リクエストのステータスを確認します。
- 'id': 一括リクエストの識別子。
- 'successful_requests_count': 処理のために正常に送信されたビデオの数。
- 'failed_requests_count': 処理に失敗したビデオの数。
curl --request POST \
--url 'https://api.immersive-fox.com/v1/bulk_requests/generate_video/' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data { \
"csv_id": 45 \
"subtitles_flag": false \
"video_name": "My First Video" \
"configurations": [ \
{ \
"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_number": 1, \
"scene_transition": "none", \
"audio_id": 2, \
"audio_service": "google_audio", \
"user_voice_speed": 1, \
"x_position": 0.604931, \
"y_position": 0.43101 \
} \
] \
}
=== 「レスポンス」
```javascript
{
"id": 178,
"message": "Requests Created",
"successful_requests_count": 3,
"failed_requests_count": 0,
"failed_requests": []
}
```