Claude Platform Docs

Lotes

Crear un lote de mensajes
client.Messages.Batches.New(ctx, params) (*MessageBatch, error)
POST/v1/messages/batches

Envía un lote de solicitudes de creación de mensajes.

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

Este endpoint es idempotente y puede usarse para sondear la finalización de un lote de mensajes. Para acceder a los resultados de un lote de mensajes, realiza una solicitud al campo results_url de la respuesta.

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

Lista todos los lotes de mensajes dentro de un Workspace. Los lotes creados más recientemente se devuelven primero.

Cancelar un lote de mensajes
client.Messages.Batches.Cancel(ctx, messageBatchID, body) (*MessageBatch, error)
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.

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

Elimina un lote de mensajes.

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

Devuelve en streaming los resultados de un lote de mensajes como un archivo .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