Struct ApiError 

pub struct ApiError {
    pub status: u16,
    pub kind: ApiErrorKind,
    pub message: Option<String>,
    pub error_type: Option<String>,
    pub code: Option<String>,
    pub param: Option<String>,
    pub request_id: Option<String>,
    pub body: Option<Value>,
}

A response with a non-2xx status (APIStatusError in the SDKs).

Fields

status: u16

kind: ApiErrorKind

message: Option<String>

error.message from the body; otherwise the whole body (truncated).

error_type: Option<String>

error.type, e.g. rate_limit_error (Anthropic) or invalid_request_error (OpenAI).

code: Option<String>

error.code (OpenAI).

param: Option<String>

error.param (OpenAI).

request_id: Option<String>

request-id (Anthropic) or x-request-id (OpenAI) header — quote it to support.

body: Option<Value>

The response body, if it was JSON.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ApiError

Same format as APIError.makeMessage in the SDKs: "{status} {message}" or "{status} status code (no body)".

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for ApiError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ApiError