Пакеты

Создать пакет сообщений

POST/v1/messages/batches

Отправьте пакет запросов на создание сообщений.

Получить пакет сообщений

GET/v1/messages/batches/{message_batch_id}

Эта конечная точка идемпотентна и может использоваться для опроса завершения пакета сообщений. Чтобы получить доступ к результатам пакета сообщений, выполните запрос по адресу, указанному в поле results_url ответа.

Список пакетов сообщений

GET/v1/messages/batches

Получите список всех пакетов сообщений в рабочем пространстве. Последние созданные пакеты возвращаются первыми.

Отменить пакет сообщений

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

Пакеты можно отменить в любой момент до окончания обработки. После инициирования отмены пакет переходит в состояние canceling, в котором система может завершить все выполняющиеся непрерываемые запросы перед окончательной отменой.

Удалить пакет сообщений

DELETE/v1/messages/batches/{message_batch_id}

Удалите пакет сообщений.

Получить результаты пакета сообщений

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

Передаёт результаты пакета сообщений в потоковом режиме в виде файла .jsonl.

Models

DeletedMessageBatch object{ 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.

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

MessageBatchCanceledResult object{ type: "canceled" }

type: "canceled"

defaultcanceled

MessageBatchErroredResult object{ type: "errored", error }

type: "errored"

defaulterrored

error: ErrorResponse { type: "error", error, request_id }

type: "error"

defaulterror

error: ErrorObject

One of the following:

request_id: string or null

MessageBatchExpiredResult object{ type: "expired" }

type: "expired"

defaultexpired

MessageBatchIndividualResponse object{ 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: MessageBatchResult

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:

MessageBatchRequestCounts 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.

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

MessageBatchResult = MessageBatchSucceededResult or MessageBatchErroredResult or MessageBatchCanceledResult or MessageBatchExpiredResult

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:

MessageBatchSucceededResult object{ type: "succeeded", message }

type: "succeeded"

defaultsucceeded

message: Message { type: "message", id, container, 8 more }