Archivos y lotes
Cancelar lote de mensajes
Cancela un lote de mensajes que aún se está procesando.
Descripción general
Solicite la cancelación de un lote de mensajes que aún se está procesando. La respuesta muestra el estado actual. processing_status suele ser canceling, y las solicitudes que ya se están ejecutando pueden terminar de procesarse. Un lote que ya ha finalizado se devuelve sin cambios.
Notas
- Después de cancelar, recupere el lote hasta que
processing_statusseaended. Las solicitudes que no habían comenzado terminarán comocanceled. - Un lote que no existe o que fue eliminado devuelve un
404. Un lote que aún no está listo para ser modificado devuelve un409; inténtelo de nuevo más tarde. - La cancelación no elimina el lote. Para eliminarlo, bórrelo después de que haya finalizado.
Solicitud
curl -X POST "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/cancel" \
-H "x-api-key: sk-your-api-key" \
-H "anthropic-version: 2023-06-01"Respuesta
{
"id": "msgbatch_01ABC123",
"type": "message_batch",
"processing_status": "canceling",
"request_counts": {
"processing": 1,
"succeeded": 1,
"errored": 0,
"canceled": 0,
"expired": 0
},
"ended_at": null,
"created_at": "2026-11-01T10:00:00Z",
"expires_at": "2026-11-02T10:00:00Z",
"cancel_initiated_at": "2026-11-01T10:05:00Z",
"archived_at": null,
"results_url": null
}Campos importantes
processing_statusstring
canceling mientras la cancelación está en curso, ended una vez que se completa. No asuma que toda solicitud de cancelación devuelve canceling.cancel_initiated_atstring|null
Cuándo se aceptó la solicitud de cancelación, o
null.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
message_batch_id*string
Identificador del lote de mensajes.
Respuesta
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json