Delete a Message Batch
messages().batches().delete(BatchDeleteParamsparams = BatchDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : DeletedMessageBatch
/v1/messages/batches/{message_batch_id}
Delete a Message Batch.
Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it.
Learn more about the Message Batches API in our user guide
Parameters
Returns
Delete a Message Batch
Kotlin
package com.anthropic.example
import com.anthropic.client.AnthropicClient
import com.anthropic.client.okhttp.AnthropicOkHttpClient
import com.anthropic.models.messages.batches.BatchDeleteParams
import com.anthropic.models.messages.batches.DeletedMessageBatch
fun main() {
val client: AnthropicClient = AnthropicOkHttpClient.fromEnv()
val deletedMessageBatch: DeletedMessageBatch = client.messages().batches().delete("message_batch_id")
}{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"type": "message_batch_deleted"
}Returns Examples
{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"type": "message_batch_deleted"
}