For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportStatusTry now
DocumentationAPI Reference
DocumentationAPI Reference
    • API Overview
  • API Guides
    • Authentication
    • Concurrency & Rate Limits
    • Batch Processing
    • Webhooks
  • Generate API
    • POSTCreate Generation
    • POSTCreate Generation with Files
    • GETGet Generation
    • GETList Generations
    • POSTEstimate Cost
  • Batch API
    • POSTCreate Batch
    • GETGet Batch
    • GETList Batches
  • Assets API
    • GETList Assets
    • GETGet Asset
  • Models API
    • GETList Models
  • Webhooks Payload Reference
      • POSTGeneration Status Update
      • POSTBatch Status Update
LogoLogo
SupportStatusTry now
Webhooks Payload ReferenceWebhooks

Batch Status Update

Payload
1{
2  "id": "batch_abc123",
3  "status": "COMPLETED",
4  "metrics": {
5    "totalGenerations": 5,
6    "successCount": 4,
7    "failedCount": 1,
8    "pendingCount": 0
9  },
10  "outputUrl": "https://api.sync.so/v2/batches/batch_abc123/result",
11  "webhookUrl": "https://your-webhook-url.com/batch-webhook",
12  "createdAt": "2024-01-15T10:30:00Z",
13  "options": {}
14}
Receive a notification when a batch completes or fails
Was this page helpful?
Previous
Built with

Headers

X-Signature-PrimarystringRequired
An HMAC signature of the payloadd

Payload

The payload of this webhook request is an object.
idstringRequired
A unique identifier for the batch.
created_atdatetimeRequired
The date and time the batch was created.
statusenumRequired
The current status of the batch.
Allowed values:
metricsobjectRequired
Metrics about the batch processing progress.
outputUrlstringRequired

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

webhookUrlstringOptional
The webhook URL for batch status notifications.

Response

200
any
Return a 200 status to indicate that the data was received successfully.