Batch Processing

Prepare Your Input File

Create a JSON Lines (.jsonl) file with your generation requests. Each line should contain a unique request_id, the endpoint (must be "/v2/generate"), and a payload with the standard generation request format (same as the Generate API). The file must be in JSON Lines (.jsonl) format with a minimum of 20 records, maximum file size of 5MB, and up to 500 requests per batch.

1
{"request_id": "request-1", "endpoint": "/v2/generate", "payload": {"model": "lipsync-2", "input": [{"type": "video", "url": "https://assets.sync.so/docs/example-video.mp4"}, {"type": "audio", "url": "https://assets.sync.so/docs/example-audio.wav"}]}}
2
{"request_id": "request-2", "endpoint": "/v2/generate", "payload": {"model": "lipsync-2", "input": [{"type": "video", "url": "https://assets.sync.so/docs/example-video.mp4"}, {"type": "audio", "url": "https://assets.sync.so/docs/example-audio.wav"}]}}

Create a Batch

1
from sync import Sync
2
3
sync = Sync()
4
5
batch = sync.batch.create(
6
    input=open("input.jsonl", "rb")
7
)
8
9
print(f"Batch created with ID: {batch.id}")

Optional parameters:

• webhook_url: Receive notifications when the batch completes
• dry_run: Set to true to validate your input file without processing

Check Batch Status

Monitor your batch progress by polling the status:

1
batch = sync.batch.get(batch_id)
2
print(f"Status: {batch.status}")
3
print(f"Progress: {batch.metrics}")

A batch can have one of the following status:

1. PENDING: Batch created, waiting to start processing
2. PROCESSING: Generations are being processed
3. COMPLETED: All generations finished (successfully or with failures)
4. FAILED: Batch processing failed entirely

Check Batch Results

When a batch completes, results are available as a JSON Lines file at the outputUrl of the get batch response. Each line contains:

1
{"request_id": "request-1", "endpoint": "/v2/generate", "payload": {...}, "status": "COMPLETED", "error": null, "response": {...}, "updated_at": "2024-01-15T10:35:00Z"}
2
{"request_id": "request-2", "endpoint": "/v2/generate", "payload": {...}, "status": "FAILED", "error": {"code": "INVALID_INPUT", "message": "..."}, "response": null, "updated_at": "2024-01-15T10:35:00Z"}

The response field contains the same data as individual Generate API responses.