배치

메시지 배치 생성

$ ant beta:messages:batches create

POST/v1/messages/batches

메시지 생성 요청의 배치를 전송합니다.

메시지 배치 조회

$ ant beta:messages:batches retrieve

GET/v1/messages/batches/{message_batch_id}

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

메시지 배치 목록 조회

$ ant beta:messages:batches list

GET/v1/messages/batches

워크스페이스 내의 모든 메시지 배치를 나열합니다. 가장 최근에 생성된 배치가 먼저 반환됩니다.

메시지 배치 취소

$ ant beta:messages:batches cancel

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

배치는 처리가 종료되기 전까지 언제든지 취소할 수 있습니다. 취소가 시작되면 배치는 canceling 상태로 전환되며, 이 시점에서 시스템은 취소를 최종 완료하기 전에 진행 중이며 중단할 수 없는 요청을 먼저 완료할 수 있습니다.

메시지 배치 삭제

$ ant beta:messages:batches delete

DELETE/v1/messages/batches/{message_batch_id}

메시지 배치를 삭제합니다.

메시지 배치 결과 조회

$ ant beta:messages:batches results

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

메시지 배치의 결과를 .jsonl 파일로 스트리밍합니다.

Models

beta_deleted_message_batch: object{ type: "message_batch_deleted", id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

id: string

ID of the Message Batch.

beta_message_batch: object{ type: "message_batch", id, archived_at, 7 more }

beta_message_batch_canceled_result: object{ type: "canceled" }

type: "canceled"

beta_message_batch_errored_result: object{ type: "errored", error }

beta_message_batch_expired_result: object{ type: "expired" }

type: "expired"

beta_message_batch_individual_response: object{ custom_id, result }

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

beta_message_batch_request_counts: object{ 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.

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.

expired: number

Number of requests in the Message Batch that have expired.

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

processing: number

Number of requests in the Message Batch that are processing.

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.

beta_message_batch_result: BetaMessageBatchSucceededResult or BetaMessageBatchErroredResult or BetaMessageBatchCanceledResult or 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.

beta_message_batch_succeeded_result: object{ type: "succeeded", message }