Back to Ai

AI_InvalidMessageRoleError

content/docs/07-reference/05-ai-sdk-errors/ai-invalid-message-role-error.mdx

2.1.10456 B
Original Source

AI_InvalidMessageRoleError

This error occurs when an invalid message role is provided.

Properties

  • role: The invalid role value
  • message: The error message (optional, auto-generated from role)

Checking for this Error

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

typescript
import { InvalidMessageRoleError } from 'ai';

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