模板资产

本指南提供了有关如何与我们的 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'

{
    "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>'

[
    {
        "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"
    }
]