Archivos y lotes

Recuperar batch

Recupera el estado actual, los recuentos y los archivos de resultados de un batch.

GET
/v1/batches/{batch_id}

Descripción general

Devuelve el estado del batch, los recuentos de solicitudes y los ID de los archivos de resultados. Un ID de batch desconocido, o un batch de otro Workspace, devuelve 404 batch_not_found.

status es uno de validating, queued, in_progress, finalizing, completed, failed, cancelling, cancelled o expired. Los archivos de resultados están listos cuando status es completed; léalos con Recuperar contenido del archivo.

Ejemplo

Solicitud

cURL
curl -X GET "https://api.tokenlab.sh/v1/batches/batch_abc123" \
  -H "Authorization: Bearer sk-your-api-key"

Ejemplo de respuesta

Respuesta

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "completed",
  "input_file_id": "file_abc123",
  "output_file_id": "file_out123",
  "error_file_id": "file_err123",
  "request_counts": { "total": 100, "completed": 98, "failed": 2 }
}

Campos importantes

request_countsobject
Recuentos de solicitudes totales, completadas, fallidas y canceladas.
output_file_idstring|null
ID del archivo de resultados exitosos.
error_file_idstring|null
ID del archivo de resultados fallidos.

Autorización

BearerAuth
AuthorizationBearer <token>

Autenticación con API Key. Cree o gestione API keys en Dashboard > API > API Keys.

Ubicación: header

Parámetros de ruta

batch_id*string

Respuesta

application/json

application/json

application/json