Claude Platform Docs

Message Batches auflisten

BatchListPage messages().batches().list(params = BatchListParams.none(), requestOptions = RequestOptions.none())
GET/v1/messages/batches

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

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

Parameters
BatchListParams params
Optional<String> afterId⁠Query parameter

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

Optional<String> beforeId⁠Query parameter

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

Optional<Long> limit⁠Query parameter

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

minimum1
maximum1000
Optional<String> workspaceId⁠Header parameter

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 MessageBatch { type = "message_batch"; id; archivedAt; /* 7 more */ }
Message Batches auflisten
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.messages.batches.BatchListPage;
import com.anthropic.models.messages.batches.BatchListParams;

public final class Main {
    private Main() {}

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

        BatchListPage page = client.messages().batches().list();
    }
}
Returns Examples
Response 200
{
  "data": [
    {
      "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
      "archived_at": "2024-08-20T18:37:24.100435Z",
      "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
      "created_at": "2024-08-20T18:37:24.100435Z",
      "ended_at": "2024-08-20T18:37:24.100435Z",
      "expires_at": "2024-08-20T18:37:24.100435Z",
      "processing_status": "in_progress",
      "request_counts": {
        "canceled": 10,
        "errored": 30,
        "expired": 10,
        "processing": 100,
        "succeeded": 50
      },
      "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
      "type": "message_batch"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}