ApiCallError

Namespace: Vercel.AI.Util

public class ApiCallError : AiSdkError, ISerializable, IErrorMarkers

A failed provider HTTP call, including retry metadata and response headers.

Inheritance: object → Exception → AiSdkError

Implements: ISerializable, IErrorMarkers

View source

Constructors

ApiCallError(string, string, object, int?, IReadOnlyDictionary<string, string>?, string?, Exception?, bool?, object?)

public ApiCallError(string message, string url, object requestBodyValues, int? statusCode = null, IReadOnlyDictionary<string, string>? responseHeaders = null, string? responseBody = null, Exception? cause = null, bool? isRetryable = null, object? data = null)

Creates the error.

Parameters

Name	Type	Description
message	string
url	string
requestBodyValues	object
statusCode	int?
responseHeaders	IReadOnlyDictionary<string, string>
responseBody	string
cause	Exception
isRetryable	bool?
data	object

View source

Fields

ErrorMarker

public const string ErrorMarker = "vercel.ai.error.AI_APICallError"

Marker for IsInstance(object).

Value: string

View source

Properties

Data

public object? Data { get; }

Parsed provider payload.

Value: object

View source

IsRetryable

public bool IsRetryable { get; }

Whether the call may be retried.

Value: bool

View source

RequestBodyValues

public object RequestBodyValues { get; }

Request body that was sent.

Value: object

View source

ResponseBody

public string? ResponseBody { get; }

Raw response body.

Value: string

View source

ResponseHeaders

public IReadOnlyDictionary<string, string>? ResponseHeaders { get; }

Response headers. Lookup is case-insensitive.

Value: IReadOnlyDictionary<string, string>

View source

StatusCode

public int? StatusCode { get; }

HTTP status, when the provider responded.

Value: int?

View source

Url

public string Url { get; }

Request URL.

Value: string

View source

Methods

GetHeader(string?)

public string? GetHeader(string? name)

Reads a response header, ignoring case.

Parameters

Name	Type	Description
name	string

Returns: string

View source

IsInstance(object?)

public static bool IsInstance(object? error)

Returns whether <code class=“paramref”>error</code> carries this error’s marker.

Parameters

Name	Type	Description
error	object

Returns: bool

View source