テンプレート アセット
このガイドでは、テンプレートの背景アセットを管理および活用するために API を操作する方法について詳しく説明します。
背景アセットのアップロード
このエンドポイントを使用すると、後でビデオ生成プロジェクトのテンプレートを作成するときに使用できる背景画像またはビデオをアップロードできます。 このリクエストを行うときは、Content-Type ヘッダーを multipart/form-data に設定することを忘れないでください。
リクエストの例
curl を使用して画像をアップロードする方法の例を次に示します。
curl --request POST \
--url 'https://api.immersive-fox.com/v1/template/background_asset_upload/' \
--header 'X-Api-Key: <your-api-key>' \
--header 'Content-Type: multipart/form-data' \
--form 'type=image' \
--form 'image=@/path/to/your/image.jpg' \
--form 'thumbnail=@/path/to/your/thumbnail.jpg'
=== 「レスポンス」
```json
{
"id": 123,
"image": "https://url/to/your/image.jpg",
"thumbnail": "https://url/to/your/thumbnail.jpg"
}
```
動画をアップロードするには、代わりに type=video と video=@/path/to/your/video.mp4 を使用します。
注
- アップロードするアセットの種類に応じて、
typeフィールドは "image" または "video" のいずれかである必要があります。 - 画像をアップロードする場合は、
thumbnailフィールドにサムネイル画像も指定する必要があります。 - アップロードしたアセットは、動画生成用のテンプレートを作成するときに参照できます。
背景アセットの一覧表示
このエンドポイントを使用すると、アセットとしてアップロードされた背景画像とビデオを一覧表示できます。 関心のあるアセットの種類を指定して、結果をフィルタリングできます。 リクエストには、type クエリ パラメータ ("image"、"video" のいずれか) を含めるようにしてください。 また、背景として使用できるデフォルトの色を一覧表示するには、"color" を指定することもできます。
リクエストの例
curl を使用して背景アセットを一覧表示する方法の例を次に示します。
curl --request GET \
--url 'https://api.immersive-fox.com/v1/template/background_assets/?type=image' \
--header 'X-Api-Key: <your-api-key>'
=== 「レスポンス」
```json
[
{
"id": 123,
"image": "https://url/to/your/image.jpg",
"thumbnail": "https://url/to/your/thumbnail.jpg"
},
{
"id": 124,
"image": "https://url/to/another/image.jpg",
"thumbnail": "https://url/to/another/thumbnail.jpg"
}
]
```