Claude Platform Docs

Lots

Créer un lot de messages
beta.messages.batches.create(**kwargs) -> BetaMessageBatch
POST/v1/messages/batches

Envoyez un lot de requêtes de création de messages.

Récupérer un lot de messages
beta.messages.batches.retrieve(message_batch_id, **kwargs) -> BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}

Ce point de terminaison est idempotent et peut être utilisé pour interroger l'état d'achèvement d'un lot de messages. Pour accéder aux résultats d'un lot de messages, effectuez une requête vers l'URL indiquée dans le champ results_url de la réponse.

Lister les lots de messages
beta.messages.batches.list(**kwargs) -> SyncPage[BetaMessageBatch]
GET/v1/messages/batches

Lister tous les lots de messages d'un espace de travail. Les lots créés le plus récemment sont renvoyés en premier.

Annuler un lot de messages
beta.messages.batches.cancel(message_batch_id, **kwargs) -> BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

Les lots peuvent être annulés à tout moment avant la fin du traitement. Une fois l'annulation lancée, le lot passe à l'état canceling, pendant lequel le système peut terminer les requêtes en cours non interruptibles avant de finaliser l'annulation.

Supprimer un lot de messages
beta.messages.batches.delete(message_batch_id, **kwargs) -> BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}
Récupérer les résultats d'un lot de messages
beta.messages.batches.results(message_batch_id, **kwargs) -> BetaMessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results

Diffuse en streaming les résultats d'un lot de messages sous forme de fichier .jsonl.

Models
class BetaDeletedMessageBatch: type: "message_batch_deleted"; id
type: Literal["message_batch_deleted"]

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted
id: str

ID of the Message Batch.

class BetaMessageBatch: type: "message_batch"; id; archived_at; ... # 7 more
class BetaMessageBatchCanceledResult: type: "canceled"
type: Literal["canceled"]
defaultcanceled
class BetaMessageBatchErroredResult: type: "errored"; error
type: Literal["errored"]
defaulterrored
error: BetaErrorResponse
type: Literal["error"]
defaulterror
error: BetaError
One of the following:
request_id: Optional[str]
class BetaMessageBatchExpiredResult: type: "expired"
type: Literal["expired"]
defaultexpired
class BetaMessageBatchIndividualResponse: custom_id; result

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

custom_id: str

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: BetaMessageBatchResult

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:
class BetaMessageBatchRequestCounts: canceled; errored; expired; ... # 2 more
canceled: int

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: int

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: int

Number of requests in the Message Batch that have expired.

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

default0
processing: int

Number of requests in the Message Batch that are processing.

default0
succeeded: int

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 BetaMessageBatchResult = ...

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:
class BetaMessageBatchSucceededResult: type: "succeeded"; message
type: Literal["succeeded"]
defaultsucceeded
message: BetaMessage