> For the documentation index, fetch https://sync.so/docs/llms.txt. Append .md to a page URL for Markdown. Documentation-search MCP: https://sync.so/docs/_mcp/server.

# List Batches

GET https://api.sync.so/v2/batch

List all batches for your organization with optional filtering by status and creation date. Results are ordered by creation date (newest first).

Reference: https://sync.so/docs/api-reference/api/batch-api/list

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://api.sync.so` (Default, default)
- `https://dev-api.sync.so` (dev)
- `http://localhost:3001` (local)

## Request

### Query parameters

- `status` (enum, optional) — Filter batches by status
  - Allowed values: `PENDING`, `JOBS_CREATED`, `PROCESSING`, `COMPLETED`, `FAILED`
- `created_after` (datetime, optional) — Filter batches created after this datetime (ISO 8601 format)
- `created_before` (datetime, optional) — Filter batches created before this datetime (ISO 8601 format)

## Response

### 200

- `list of BatchResponse`

## Errors

### 401 Unauthorized Error

Unauthorized - Invalid or missing authentication

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.

### 500 Internal Server Error

Internal Server Error - An unexpected failure on our side. The body carries errorCode internal_error and a requestId; include the requestId when contacting support.

- `message` (GenerationErrorMessage, required) — A message describing the error.
- `statusCode` (double, required) — The type of error that occurred.
- `errorCode` (string, optional) — Stable, machine-readable error code (e.g. project_not_found, voice_not_found, concurrency_limit_reached). Branch your error handling on this, not on the message text. The full catalog of codes with messages and suggested fixes is served unauthenticated at GET /v2/errors.
- `suggestion` (string, optional) — A suggested fix an agent can act on.
- `field` (string, optional) — The request field the error refers to, when the failure is tied to a specific field (e.g. projectId, voiceId, input[].assetId).
- `docsUrl` (string, optional) — Link to the documentation page for the failing operation.
- `requestId` (string, optional) — Present on unexpected 500 responses. Include it when contacting support so the failing request can be located directly.
- `generationId` (string, optional) — Original generation ID when available for an uncertain keyed submission. Poll this ID; do not create another action to bypass IDEMPOTENCY_OUTCOME_UNKNOWN.
- `dialogueEditSection` (DialogueEditRetimeFailureSection, optional) — For dialogue_edit_removal_too_large: the section to change, when it can be identified. Create a new dialogue edit preview before submitting again.

## Types

### BatchResponse

- `id` (string, required) — A unique identifier for the batch.
- `created_at` (datetime, required) — The date and time the batch was created.
- `status` (enum, required) — The current status of the batch.
  - Allowed values: `PENDING`, `JOBS_CREATED`, `PROCESSING`, `COMPLETED`, `FAILED`
- `metrics` (BatchMetrics, required) — Metrics about the batch processing progress.
- `outputUrl` (string, required) — The URL to download the batch results file when completed. A GET request follows a 302 redirect to a signed JSONL result URL.
- `webhookUrl` (string, optional) — The webhook URL for batch status notifications. Deliveries include a Sync-Signature header signed with the organization webhook secret.

### GenerationErrorMessage

A message describing the error.

### DialogueEditRetimeFailureSection

The dialogue-edit section that removes too much speech to stay in sync.

- `slotIndex` (integer, required) — Zero-based index of the section in the preview's `resultSlots`.
- `sourceStartMs` (integer, optional) — Start of the section in the source video, in absolute milliseconds.
- `sourceDurationMs` (integer, optional) — Length of the section in the source video, in milliseconds.

### BatchMetrics

- `total_generations` (integer, required) — Total number of generation requests in the batch.
- `success_count` (integer, required) — Number of successfully completed generations.
- `failed_count` (integer, required) — Number of failed generations.
- `pending_count` (integer, required) — Number of generations still pending or processing.

## Examples

**Response**

```json
[
  {
    "id": "batch_abc123",
    "created_at": "2024-01-15T10:30:00Z",
    "status": "COMPLETED",
    "metrics": {
      "total_generations": 5,
      "success_count": 4,
      "failed_count": 1,
      "pending_count": 0
    },
    "outputUrl": "https://api.sync.so/v2/batches/batch_abc123/result",
    "webhookUrl": "https://your-webhook-url.com/batch-webhook"
  },
  {
    "id": "batch_def456",
    "created_at": "2024-01-14T15:20:00Z",
    "status": "PROCESSING",
    "metrics": {
      "total_generations": 10,
      "success_count": 3,
      "failed_count": 0,
      "pending_count": 7
    },
    "outputUrl": "",
    "webhookUrl": null
  }
]
```

**SDK Code**

```python ListBatches
import requests

url = "https://api.sync.so/v2/batch"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript ListBatches
const url = 'https://api.sync.so/v2/batch';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ListBatches
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sync.so/v2/batch"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby ListBatches
require 'uri'
require 'net/http'

url = URI("https://api.sync.so/v2/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java ListBatches
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sync.so/v2/batch")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php ListBatches
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sync.so/v2/batch', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp ListBatches
using RestSharp;

var client = new RestClient("https://api.sync.so/v2/batch");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift ListBatches
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sync.so/v2/batch")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```