Manage CSV

This API guide provides an overview of how a csv is used to generate bulk request.

---

To initiate a bulk request you will need to provide a csv file containing all the template variable names as csv columns headers:

Sample template text: Hi My name is {{First Name}} {{Last Name}} and I have been working in {{Company}} for last ten years.

First Name	Last Name	Company
Johan	Smith	Immersivefox
Jack	Parker	Red Chillies

These fields will be used as macros in the bulk processing to personalize and customize the generated content. 🌟

Quick Start

Let’s dive in and explore how to upload and list your csv files, so you can efficiently generate bulk videos using them later.

Uploading CSV

To upload a new CSV file, use this API endpoint. Simply pass the CSV file in the request data and send data as multipart/form-data. In response, you will receive a 'id' which you can use as 'csv_id' to create bulk requests and templates. For reference, here is a sample CSV file.

RequestResponse

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",
}

Listing CSV

To retrieve previously uploaded CSV files, use this API endpoint. The response will include a list of all CSV files, and you can use the 'id' of the desired CSV as 'csv_id' to create bulk requests and templates.

RequestResponse

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",
    }
]