list() — anthropic-sdk-python Function Reference

Architecture documentation for the list() function in batches.py from the anthropic-sdk-python codebase.

Function python AnthropicClient SyncClient calls 1 called by 1

Entity Profile

AnthropicClient→ SyncClient→ list() — anthropic-sdk-python Function Reference

Dependency Diagram

graph TD
  25ab2731_8453_89d6_bc73_ef73b28bd127["list()"]
  2f3d80a0_1918_de2a_dee2_ee2355827836["Batches"]
  25ab2731_8453_89d6_bc73_ef73b28bd127 -->|defined in| 2f3d80a0_1918_de2a_dee2_ee2355827836
  a5524070_8ae8_cf3e_0807_f0d7d090f3b6["list()"]
  a5524070_8ae8_cf3e_0807_f0d7d090f3b6 -->|calls| 25ab2731_8453_89d6_bc73_ef73b28bd127
  a5524070_8ae8_cf3e_0807_f0d7d090f3b6["list()"]
  25ab2731_8453_89d6_bc73_ef73b28bd127 -->|calls| a5524070_8ae8_cf3e_0807_f0d7d090f3b6
  style 25ab2731_8453_89d6_bc73_ef73b28bd127 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/anthropic/resources/beta/messages/batches.py lines 160–232

    def list(
        self,
        *,
        after_id: str | Omit = omit,
        before_id: str | Omit = omit,
        limit: int | Omit = omit,
        betas: List[AnthropicBetaParam] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> SyncPage[BetaMessageBatch]:
        """List all Message Batches within a Workspace.

        Most recently created batches are
        returned first.

        Learn more about the Message Batches API in our
        [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing)

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

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

          limit: Number of items to return per page.

              Defaults to `20`. Ranges from `1` to `1000`.

          betas: Optional header to specify the beta version(s) you want to use.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        extra_headers = {
            **strip_not_given(
                {
                    "anthropic-beta": ",".join(chain((str(e) for e in betas), ["message-batches-2024-09-24"]))
                    if is_given(betas)
                    else not_given
                }
            ),
            **(extra_headers or {}),
        }
        extra_headers = {"anthropic-beta": "message-batches-2024-09-24", **(extra_headers or {})}
        return self._get_api_list(
            "/v1/messages/batches?beta=true",
            page=SyncPage[BetaMessageBatch],
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                query=maybe_transform(
                    {
                        "after_id": after_id,
                        "before_id": before_id,
                        "limit": limit,
                    },
                    batch_list_params.BatchListParams,
                ),
            ),
            model=BetaMessageBatch,
        )