機能の概要
テキストから動画を生成するAPIで、非同期モードのみをサポートしています。このAPIを呼び出すと、入力されたテキストの説明に基づいて動画生成タスクが作成され、タスクIDが返されます。タスクの実行結果は、/api/v1/tasks/{task_id} APIを使用して確認する必要があります。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPI Keyを保有している必要があります。詳細については、AI API Keyの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/videos/generations
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
| X-Async | いいえ | enable | 省略可能です。明示的に設定する場合は、enable または true のみをサポートします。省略した場合、デフォルトで非同期です。 |
リクエストパラメータ
Bodyパラメータ
実行結果
戻り値パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスが返すデータ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| task_id | string | 生成されたビデオタスクID。後続のタスク状態と結果のクエリに使用されます |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/videos/generations' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "video-gen-model-v1"
}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"task_id": "task-1234567890abcdef"
}
}