Skip to main content

Get Batch Progress

Endpoint

POST /v1/batches/{batchId}/progress

Description

Retrieves the current fill status of selected rows in a previously created batch.
This is useful for tracking which rows have been processed, are still in progress, or encountered errors.

You can call this endpoint repeatedly to monitor autofill progress after triggering fill-forms.

⚠️ Important: Continue calling this endpoint until all requested row_ids contain a pdfUrl.
This indicates that each corresponding row has been successfully processed and a filled PDF is available.


Request

Path Parameters

ParameterTypeRequiredDescription
batchIdstringID of the batch to check progress for.

Headers

HeaderRequiredDescription
AuthorizationBearer YOUR_API_KEY
Content-Typeapplication/json

Body (JSON)

{
"row_ids": [0, 1, 2]
}

Success Response — 200 OK

{
"id": "pf_145e969cf6bf439ab0616cec484ff8b1",
"object": "progress_fill",
"status": [
{
"rowId": "0",
"pdfUrl": "https://filled-pdf-url1.com"
},
{
"rowId": "1",
"pdfUrl": "https://filled-pdf-url2.com"
}
]
}