Get Batch | Sync

Retrieve details about a specific batch, including its current status, processing metrics, and output file URL when available.

x-api-keystring

API Key authentication via header

idstringRequired

The unique identifier of the batch

This endpoint returns an object.

idstring

A unique identifier for the batch.

created_atdatetime

The date and time the batch was created.

statusenum

The current status of the batch.

Allowed values:

metricsobject

Metrics about the batch processing progress.

outputUrlstring

The URL to download the batch results file (available when completed).

webhookUrlstring

The webhook URL for batch status notifications.

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

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