Batches

Einen Message Batch erstellen

client.beta.messages.batches.create(params, options?): BetaMessageBatch

POST/v1/messages/batches

Sende einen Batch von Anfragen zur Erstellung von Nachrichten.

Einen Message Batch abrufen

client.beta.messages.batches.retrieve(messageBatchID, params?, options?): BetaMessageBatch

GET/v1/messages/batches/{message_batch_id}

Dieser Endpunkt ist idempotent und kann verwendet werden, um den Abschluss eines Message Batch per Polling abzufragen. Um auf die Ergebnisse eines Message Batch zuzugreifen, sende eine Anfrage an die im Feld results_url der Antwort angegebene URL.

Message Batches auflisten

client.beta.messages.batches.list(params?, options?): Page<BetaMessageBatch>

GET/v1/messages/batches

Liste alle Message Batches innerhalb eines Workspace auf. Die zuletzt erstellten Batches werden zuerst zurückgegeben.

Einen Message Batch abbrechen

client.beta.messages.batches.cancel(messageBatchID, params?, options?): BetaMessageBatch

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

Batches können jederzeit vor Ende der Verarbeitung abgebrochen werden. Sobald der Abbruch eingeleitet wurde, wechselt der Batch in den Zustand canceling; in dieser Zeit kann das System laufende, nicht unterbrechbare Anfragen noch abschließen, bevor der Abbruch finalisiert wird.

Einen Message Batch löschen

client.beta.messages.batches.delete(messageBatchID, params?, options?): BetaDeletedMessageBatch

DELETE/v1/messages/batches/{message_batch_id}

Lösche einen Message Batch.

Ergebnisse eines Message Batch abrufen

client.beta.messages.batches.results(messageBatchID, params?, options?): BetaMessageBatchIndividualResponse | Stream<BetaMessageBatchIndividualResponse>

GET/v1/messages/batches/{message_batch_id}/results

Streamt die Ergebnisse eines Message Batch als .jsonl-Datei.

Models

interface BetaDeletedMessageBatch { type: "message_batch_deleted"; id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted

id: string

ID of the Message Batch.

interface BetaMessageBatch { type: "message_batch"; id; archived_at; /* 7 more */ }

interface BetaMessageBatchCanceledResult { type: "canceled" }

type: "canceled"

defaultcanceled

interface BetaMessageBatchErroredResult { type: "errored"; error }

type: "errored"

defaulterrored

error: BetaErrorResponse { type: "error"; error; request_id }

type: "error"

defaulterror

error: BetaError

One of the following:

request_id: string | null

interface BetaMessageBatchExpiredResult { type: "expired" }

type: "expired"

defaultexpired

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

interface BetaMessageBatchRequestCounts { canceled; errored; expired; /* 2 more */ }

canceled: number

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

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

Number of requests in the Message Batch that have expired.

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

default0

processing: number

Number of requests in the Message Batch that are processing.

default0

succeeded: number

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 = BetaMessageBatchSucceededResult | BetaMessageBatchErroredResult | BetaMessageBatchCanceledResult | BetaMessageBatchExpiredResult

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:

interface BetaMessageBatchSucceededResult { type: "succeeded"; message }

type: "succeeded"

defaultsucceeded

message: BetaMessage { type: "message"; id; container; /* 10 more */ }