Create Batch

API for Batch Processing. Available only for Growth and Scale plans.

This endpoint expects a multipart form containing a file.

inputfileRequired

JSON lines file containing batch requests. Maximum file size: 5MB. Maximum requests per batch: 1000.

webhook_urlstringOptional

Optional webhook URL to receive batch completion notifications. A POST request will be sent when the batch completes or fails.

dry_runbooleanOptionalDefaults to false

When true, validates the input file without processing. Returns validation status without creating generations.

This endpoint returns an object.

Batch Responseobject

Validation Responseobject

1	curl -X POST https://api.sync.so/v2/batch \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: multipart/form-data" \
4	-F input=@<file1> \
5	-F webhook_url="https://your-webhook-url.com/batch-webhook" \
6	-F dry_run='false'

1	{
2	"id": "batch_abc123",
3	"created_at": "2024-01-15T10:30:00Z",
4	"status": "PENDING",
5	"metrics": {
6	"total_generations": 5,
7	"success_count": 0,
8	"failed_count": 0,
9	"pending_count": 0
10	},
11	"webhookUrl": "https://your-webhook-url.com/batch-webhook",
12	"outputUrl": ""
13	}