Einen Message Batch löschen

DeletedMessageBatch messages().batches().delete(params = BatchDeleteParams.none(), requestOptions = RequestOptions.none())

DELETE/v1/messages/batches/{message_batch_id}

Lösche einen Message Batch.

Message Batches können erst gelöscht werden, wenn ihre Verarbeitung abgeschlossen ist. Wenn du einen laufenden Batch löschen möchtest, musst du ihn zuerst abbrechen.

Mehr über die Message Batches API erfährst du in unserem Benutzerhandbuch

Parameters

BatchDeleteParams params

Optional<String> messageBatchId⁠Path

ID of the Message Batch.

Optional<String> workspaceId⁠Header

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns

class DeletedMessageBatch { type = "message_batch_deleted"; id; }

JsonValue type = "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

String id

ID of the Message Batch.

Einen Message Batch löschen

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;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        DeletedMessageBatch deletedMessageBatch = client.messages().batches().delete("message_batch_id");
    }
}

Response 200

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}

Returns Examples

Response 200

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}