Claude Platform Docs

Lotes

Criar um lote de mensagens
client.Messages.Batches.New(ctx, params) (*MessageBatch, error)
POST/v1/messages/batches

Envie um lote de solicitações de criação de mensagens.

Recuperar um lote de mensagens
client.Messages.Batches.Get(ctx, messageBatchID, query) (*MessageBatch, error)
GET/v1/messages/batches/{message_batch_id}

Este endpoint é idempotente e pode ser usado para fazer polling da conclusão de um lote de mensagens. Para acessar os resultados de um lote de mensagens, faça uma solicitação para o campo results_url na resposta.

Listar lotes de mensagens
client.Messages.Batches.List(ctx, params) (*Page[MessageBatch], error)
GET/v1/messages/batches

Liste todos os lotes de mensagens em um Workspace. Os lotes criados mais recentemente são retornados primeiro.

Cancelar um lote de mensagens
client.Messages.Batches.Cancel(ctx, messageBatchID, body) (*MessageBatch, error)
POST/v1/messages/batches/{message_batch_id}/cancel

Os lotes podem ser cancelados a qualquer momento antes do término do processamento. Depois que o cancelamento é iniciado, o lote entra em um estado canceling, momento em que o sistema pode concluir quaisquer solicitações em andamento e não interrompíveis antes de finalizar o cancelamento.

Excluir um lote de mensagens
client.Messages.Batches.Delete(ctx, messageBatchID, body) (*DeletedMessageBatch, error)
DELETE/v1/messages/batches/{message_batch_id}

Exclua um lote de mensagens.

Recuperar resultados de um lote de mensagens
client.Messages.Batches.ResultsStreaming(ctx, messageBatchID, query) *jsonl.Stream[MessageBatchIndividualResponse]
GET/v1/messages/batches/{message_batch_id}/results

Faz streaming dos resultados de um lote de mensagens como um arquivo .jsonl.

Models
type DeletedMessageBatch struct { Type: "message_batch_deleted"; ID }
Type MessageBatchDeleted

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted
ID string

ID of the Message Batch.

type MessageBatch struct { Type: "message_batch"; ID; ArchivedAt; /* 7 more */ }
type MessageBatchCanceledResult struct { Type: "canceled" }
Type Canceled
defaultcanceled
type MessageBatchErroredResult struct { Type: "errored"; Error }
Type Errored
defaulterrored
Error ErrorResponse
Type Error
defaulterror
Error ErrorObjectUnion
One of the following:
RequestID string
type MessageBatchExpiredResult struct { Type: "expired" }
Type Expired
defaultexpired
type MessageBatchIndividualResponse struct { CustomID; Result }

This is a single line in the response .jsonl file and does not represent the response as a whole.

CustomID string

Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.

Must be unique for each request within the Message Batch.

Result MessageBatchResultUnion

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:
type MessageBatchRequestCounts struct { Canceled; Errored; Expired; /* 2 more */ }
Canceled int64

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

default0
Errored int64

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

default0
Expired int64

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

default0
Processing int64

Number of requests in the Message Batch that are processing.

default0
Succeeded int64

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

default0
type MessageBatchResultUnion interface{…}

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:
type MessageBatchSucceededResult struct { Type: "succeeded"; Message }
Type Succeeded
defaultsucceeded
Message Message