跳转至

管理 CSV

本 API 指南概述了如何使用 csv 生成批量请求。


要启动批量请求,您需要提供一个 csv 文件,其中包含所有模板变量名作为 csv 列标题: 示例模板文本: 嗨,我的名字是 {{First Name}} {{Last Name}},我在 {{Company}} 工作了十年。 | 名字 | 姓氏 | 公司 | |------------|------------|---------------| | 约翰 | 史密斯 | Immersivefox | | 杰克 | 帕克 | Red Chillies |

这些字段将用作批量处理中的宏,以个性化和自定义生成的内容。 🌟

快速入门

让我们深入探索如何上传和列出您的 csv 文件,以便您以后可以使用它们有效地生成批量视频。

上传 CSV

要上传新的 CSV 文件,请使用此 API 端点。只需在请求数据中传递 CSV 文件并将数据作为"multipart/form-data"发送即可。作为响应,您将收到一个'id',您可以将其用作'csv_id'来创建批量请求模板。作为参考,这里有一个示例CSV 文件

curl --request POST  \
     --url 'https://api.immersive-fox.com/v1/bulk_requests/upload_csv/'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: multipart/form-data' \
      -F 'csv_file=@my_contacts.csv'
{
    "id": 172,
    "user": 31,
    "file_name": "my_contacts.csv",
}

列出 CSV

要检索之前上传的 CSV 文件,请使用此 API 端点。响应将包含所有 CSV 文件的列表,您可以使用所需 CSV 的 'id' 作为 'csv_id' 来创建 批量请求模板

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/bulk_requests/csvs/'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'
[
    {
        "id": 120,
        "user": 31,
        "file_name": "my_contacts.csv",
    },
    {
        "id": 159,
        "user": 31,
        "file_name": "my_employees.csv",
    }
]