Class APIRequest

src/anthropic/_request.py:15–114

A view over the request that the client is about to execute. Treat instances as immutable; use `copy()` to derive a modified request.

class APIRequest:
    """A view over the request that the client is about to execute.

    Treat instances as immutable; use `copy()` to derive a modified request.
    """

    def __init__(
        self,
        *,
        options: FinalRequestOptions,
        cast_to: Any,
        stream: bool = False,
        stream_cls: type[Any] | None = None,
        retries_taken: int = 0,
    ) -> None:
        self.options = options
        self.cast_to = cast_to
        self.stream = stream
        self.stream_cls = stream_cls
        self.retries_taken = retries_taken
        """The number of retries the SDK has already taken for this call.

        `0` on the first attempt; the middleware chain is invoked once per HTTP attempt.
        """

    @property
    def method(self) -> str:
        return self.options.method

    @property
    def url(self) -> str:
        return self.options.url

    @property
    def headers(self) -> Headers:
        headers = self.options.headers
        return headers if is_given(headers) else {}

    @property
    def query_params(self) -> Query:
        return self.options.params

    @property
    def json(self) -> Body | None:
        return self.options.json_data

    @property
    def timeout(self) -> float | httpx.Timeout | None | NotGiven:
        return self.options.timeout

    @property
    def max_retries(self) -> int | NotGiven:
        return self.options.max_retries

    def copy(
        self,
        *,
        method: str | NotGiven = not_given,