Archivos y lotes

Cancelar batch

Cancela un batch que no ha finalizado.

POST
/v1/batches/{batch_id}/cancel

Solicita la cancelación de un batch en cola o en ejecución. La respuesta contiene su estado actual: la cancelación puede estar aún en curso o ya haberse completado. Un batch que ya haya finalizado conserva su estado terminal existente. Si el estado devuelto no es terminal, recupera el batch nuevamente para verificar el resultado. Un ID de batch desconocido devuelve 404 batch_not_found.

Solicitud

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

Respuesta

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}
idstring
ID del batch.
statusstring
Estado actual del batch. No asuma que cada solicitud de cancelación exitosa devuelve cancelling.

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