Passer à la navigation
Batch API

Get Batch

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

Authentification

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

Paramètres de chemin

idstringRequis
The unique identifier of the batch

Réponse

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.
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
404
Not Found Error
500
Internal Server Error