Back to Ai

AI_NoImageGeneratedError

content/docs/07-reference/05-ai-sdk-errors/ai-no-image-generated-error.mdx

2.1.10963 B
Original Source

AI_NoImageGeneratedError

This error occurs when the AI provider fails to generate an image. It can arise due to the following reasons:

  • The model failed to generate a response.
  • The model generated an invalid response.

Properties

  • message: The error message (optional, defaults to 'No image generated.').
  • responses: Metadata about the image model responses, including timestamp, model, and headers (optional).
  • cause: The cause of the error. You can use this for more detailed error handling (optional).

Checking for this Error

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

typescript
import { generateImage, NoImageGeneratedError } from 'ai';

try {
  await generateImage({ model, prompt });
} catch (error) {
  if (NoImageGeneratedError.isInstance(error)) {
    console.log('NoImageGeneratedError');
    console.log('Cause:', error.cause);
    console.log('Responses:', error.responses);
  }
}