Skip to main content

Create Batch from Table

Endpoint​

POST /v1/batches

Description​

Creates a new autofill batch session by uploading a table file (typically CSV or Excel) that contains multiple rows of data to be filled into a specified PDF form. Each row becomes a separate autofill session.

This is useful when you want to fill the same form for many users/records using a structured data table.

Request​

Headers​

HeaderRequiredDescription
Authorization✓Bearer YOUR_API_KEY
Content-Type✓multipart/form-data

Form Data Parameters​

FieldTypeRequiredDescription
form_idstring✓The ID of the form to fill using data from the uploaded file.
filefile✓The table file to upload (e.g., .csv, .xlsx). Each row maps to a session.

The file is parsed and forwarded to the downstream batch processor, and the batch ID is returned in the response.

Success Response — 200 OK​

{
    "id": "cb35f3386e1cb9416396b9807d0ac044c8",
    "created": "2025-07-03T09:38:19.8435845Z",
    "object": "create_batch",
    "batch_id": "68664fd5045c526a1ebd0004"
}