Claude Platform Docs

메시지 배치 조회

MessageBatch Messages.Batches.Retrieve(parameters, cancellationToken = default)
GET/v1/messages/batches/{message_batch_id}

이 엔드포인트는 멱등성(idempotent)을 가지며 메시지 배치 완료 여부를 폴링하는 데 사용할 수 있습니다. 메시지 배치의 결과에 액세스하려면 응답의 results_url 필드로 요청을 보내세요.

Message Batches API에 대한 자세한 내용은 사용자 가이드를 참조하세요.

Parameters
BatchRetrieveParams parameters
required string messageBatchID

ID of the Message Batch.

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 MessageBatch { Type = "message_batch"; ID; ArchivedAt; /* 7 more */ }
메시지 배치 조회
BatchRetrieveParams parameters = new() { MessageBatchID = "message_batch_id" };

var messageBatch = await client.Messages.Batches.Retrieve(parameters);

Console.WriteLine(messageBatch);
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"
}