Claude Platform Docs

Cancelar un lote de mensajes

client.messages.batches.cancel(messageBatchID, params?, options?): MessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

Los lotes pueden cancelarse en cualquier momento antes de que finalice el procesamiento. Una vez iniciada la cancelación, el lote entra en estado canceling, momento en el cual el sistema puede completar cualquier solicitud en curso no interrumpible antes de finalizar la cancelación.

El número de solicitudes canceladas se especifica en request_counts. Para determinar qué solicitudes se cancelaron, revisa los resultados individuales dentro del lote. Ten en cuenta que la cancelación puede no dar lugar a ninguna solicitud cancelada si estas no eran interrumpibles.

Obtén más información sobre la API de Message Batches en nuestra guía de usuario

Parameters
messageBatchID: string⁠Path parameter

ID of the Message Batch.

params: BatchCancelParams { workspace_id }
workspace_id?: string⁠Header parameter

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
interface MessageBatch { type: "message_batch"; id; archived_at; /* 7 more */ }
Cancelar un lote de mensajes
import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const messageBatch = await client.messages.batches.cancel("message_batch_id");

console.log(messageBatch.id);
Returns Examples
Response 200
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "archived_at": "2024-08-20T18:37:24.100435Z",
  "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
  "created_at": "2024-08-20T18:37:24.100435Z",
  "ended_at": "2024-08-20T18:37:24.100435Z",
  "expires_at": "2024-08-20T18:37:24.100435Z",
  "processing_status": "in_progress",
  "request_counts": {
    "canceled": 10,
    "errored": 30,
    "expired": 10,
    "processing": 100,
    "succeeded": 50
  },
  "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
  "type": "message_batch"
}