Image generation capabilities using xAI's image models through the AI SDK framework.
// Required imports for type definitions
import type { ImageModelV2 } from '@ai-sdk/provider';Methods for creating image model instances from the provider.
/**
* Creates an image model for image generation
* @param modelId - xAI image model identifier
* @returns ImageModelV2 instance for image generation
*/
image(modelId: XaiImageModelId): ImageModelV2;
/**
* Creates an image model (alias for image method)
* @param modelId - xAI image model identifier
* @returns ImageModelV2 instance for image generation
*/
imageModel(modelId: XaiImageModelId): ImageModelV2;Usage Examples:
import { xai } from '@ai-sdk/xai';
import { generateImage } from 'ai';
// Create image model instance
const imageModel = xai.image('grok-2-image');
// Alternative method
const altImageModel = xai.imageModel('grok-2-image');
// Use with AI SDK generateImage function
const { image } = await generateImage({
model: xai.image('grok-2-image'),
prompt: 'A serene mountain landscape at sunset',
});Available xAI image model identifiers.
type XaiImageModelId =
| 'grok-2-image'
| (string & {});Model Details:
Practical examples of image generation with different prompts and configurations.
Usage Examples:
import { xai } from '@ai-sdk/xai';
import { generateImage } from 'ai';
// Basic image generation
const { image } = await generateImage({
model: xai.image('grok-2-image'),
prompt: 'A futuristic cityscape with flying cars',
});
// With custom provider settings
import { createXai } from '@ai-sdk/xai';
const customProvider = createXai({
apiKey: 'your-api-key',
headers: {
'X-Custom-Header': 'value',
},
});
const customImage = await generateImage({
model: customProvider.image('grok-2-image'),
prompt: 'An abstract painting in the style of Kandinsky',
});
// Access image data
console.log(image.base64); // Base64 encoded image data
console.log(image.url); // Image URL if availableAll xAI image models implement the AI SDK's ImageModelV2 interface, providing full compatibility with AI SDK image generation functions.
// Returned by image model methods
interface ImageModelV2 {
// Full AI SDK ImageModelV2 interface implementation
// Supports generateImage and related functions
}Image generation uses the same error handling structure as other xAI provider operations.
interface XaiErrorData {
error: {
message: string;
type?: string | null;
param?: any;
code?: string | number | null;
};
}Common error scenarios: