Annulla un batch di messaggi

BetaMessageBatch Beta.Messages.Batches.Cancel(parameters, cancellationToken = default)

POST/v1/messages/batches/{message_batch_id}/cancel

I batch possono essere annullati in qualsiasi momento prima del termine dell'elaborazione. Una volta avviato l'annullamento, il batch entra nello stato canceling, durante il quale il sistema può completare eventuali richieste in corso non interrompibili prima di finalizzare l'annullamento.

Il numero di richieste annullate è specificato in request_counts. Per determinare quali richieste sono state annullate, controlla i singoli risultati all'interno del batch. Tieni presente che l'annullamento potrebbe non comportare alcuna richiesta annullata se le richieste erano non interrompibili.

Scopri di più sull'API Message Batches nella nostra guida per l'utente

Parameters

BatchCancelParams parameters

required string messageBatchID

ID of the Message Batch.

IReadOnlyList<AnthropicBeta> betas

Optional header to specify the beta version(s) you want to use.

MessageBatches2024_09_24("message-batches-2024-09-24")

PromptCaching2024_07_31("prompt-caching-2024-07-31")

ComputerUse2024_10_22("computer-use-2024-10-22")

ComputerUse2025_01_24("computer-use-2025-01-24")

Pdfs2024_09_25("pdfs-2024-09-25")

TokenCounting2024_11_01("token-counting-2024-11-01")

TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")

Output128k2025_02_19("output-128k-2025-02-19")

FilesApi2025_04_14("files-api-2025-04-14")

McpClient2025_04_04("mcp-client-2025-04-04")

McpClient2025_11_20("mcp-client-2025-11-20")

DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")

InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")

CodeExecution2025_05_22("code-execution-2025-05-22")

ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")

Context1m2025_08_07("context-1m-2025-08-07")

ContextManagement2025_06_27("context-management-2025-06-27")

ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")

Skills2025_10_02("skills-2025-10-02")

FastMode2026_02_01("fast-mode-2026-02-01")

Output300k2026_03_24("output-300k-2026-03-24")

UserProfiles2026_03_24("user-profiles-2026-03-24")

UserProfiles2026_08_18("user-profiles-2026-08-18")

UserProfiles2026_09_04("user-profiles-2026-09-04")

AdvisorTool2026_03_01("advisor-tool-2026-03-01")

ManagedAgents2026_04_01("managed-agents-2026-04-01")

CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")

Dreaming2026_04_21("dreaming-2026-04-21")

ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")

ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")

ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")

FallbackCredit2026_06_01("fallback-credit-2026-06-01")

FallbackCredit2026_07_01("fallback-credit-2026-07-01")

AgentMemory2026_07_22("agent-memory-2026-07-22")

MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")

Compact2026_01_12("compact-2026-01-12")

ComputerUse2025_11_24("computer-use-2025-11-24")

McpTunnels2026_06_22("mcp-tunnels-2026-06-22")

StructuredOutputs2025_11_13("structured-outputs-2025-11-13")

TaskBudgets2026_03_13("task-budgets-2026-03-13")

ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")

CEUserManagement2026_07_13("ce-user-management-2026-07-13")

MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")

ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")

MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")

Compact2026_09_04("compact-2026-09-04")

string workspaceID

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

class BetaMessageBatch { Type = "message_batch"; ID; ArchivedAt; /* 7 more */ }

Annulla un batch di messaggi

BatchCancelParams parameters = new() { MessageBatchID = "message_batch_id" };

var betaMessageBatch = await client.Beta.Messages.Batches.Cancel(parameters);

Console.WriteLine(betaMessageBatch);

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"
}

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"
}