Passer à la navigation
Batch API

List Batches

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

Authentification

x-api-keystring
Authentification par clé API via en-tête

Paramètres de requête

statusenumOptionnel
Filter batches by status
Valeurs autorisées:
created_afterdatetimeOptionnel

Filter batches created after this datetime (ISO 8601 format)

created_beforedatetimeOptionnel

Filter batches created before this datetime (ISO 8601 format)

Réponse

This endpoint returns a list of objects.
idstring
A unique identifier for the batch.
created_atdatetime
The date and time the batch was created.
statusenum
The current status of the batch.
Valeurs autorisées:
metricsobject
Metrics about the batch processing progress.
outputUrlstring
The URL to download the batch results file when completed. A GET request follows a 302 redirect to a signed JSONL result URL.
webhookUrlstringOptionnel

The webhook URL for batch status notifications. Deliveries include a Sync-Signature header signed with the organization webhook secret.

Erreurs

401
Unauthorized Error
500
Internal Server Error