AI_APICallError

This error occurs when an API call fails.

Properties

• url: The URL of the API request that failed
• requestBodyValues: The request body values sent to the API
• statusCode: The HTTP status code returned by the API (optional)
• responseHeaders: The response headers returned by the API (optional)
• responseBody: The response body returned by the API (optional)
• isRetryable: Whether the request can be retried based on the status code
• data: Any additional data associated with the error (optional)
• cause: The underlying error that caused the API call to fail (optional)

When this error is created for an AI SDK UI chat transport or completion request, requestBodyValues is undefined so prompts and messages are not copied into the client-facing error object.

Checking for this Error

You can check if an error is an instance of AI_APICallError using:

import { APICallError } from 'ai';

if (APICallError.isInstance(error)) {
  // Handle the error
}