Docs
CodeRabbit
Cloudflare
Railway
WorkOS
AG Grid
Clerk
Netlify
SerpAPI
OpenRouter
Sentry
Unkey
Prisma
Electric
CodeRabbit
Cloudflare
Railway
WorkOS
AG Grid
Clerk
Netlify
SerpAPI
OpenRouter
Sentry
Unkey
Prisma
Electric
Class References
Function References
Interface References
Type Alias References
Variable References

generateImage

Function: generateImage()

ts
function generateImage<TAdapter, TStream>(options): ImageActivityResult<TStream>;
function generateImage<TAdapter, TStream>(options): ImageActivityResult<TStream>;

Defined in: packages/ai/src/activities/generateImage/index.ts:176

Image activity - generates images from text prompts.

Uses AI image generation models to create images based on natural language descriptions.

Type Parameters

TAdapter

TAdapter extends ImageAdapter<string, any, any, any>

TStream

TStream extends boolean = false

Parameters

options

ImageActivityOptions<TAdapter, TStream>

Returns

ImageActivityResult<TStream>

Examples

ts
import { generateImage } from '@tanstack/ai'
import { openaiImage } from '@tanstack/ai-openai'

const result = await generateImage({
  adapter: openaiImage('dall-e-3'),
  prompt: 'A serene mountain landscape at sunset'
})

console.log(result.images[0].url)
import { generateImage } from '@tanstack/ai'
import { openaiImage } from '@tanstack/ai-openai'

const result = await generateImage({
  adapter: openaiImage('dall-e-3'),
  prompt: 'A serene mountain landscape at sunset'
})

console.log(result.images[0].url)
ts
const result = await generateImage({
  adapter: openaiImage('dall-e-2'),
  prompt: 'A cute robot mascot',
  numberOfImages: 4,
  size: '512x512'
})

result.images.forEach((image, i) => {
  console.log(`Image ${i + 1}: ${image.url}`)
})
const result = await generateImage({
  adapter: openaiImage('dall-e-2'),
  prompt: 'A cute robot mascot',
  numberOfImages: 4,
  size: '512x512'
})

result.images.forEach((image, i) => {
  console.log(`Image ${i + 1}: ${image.url}`)
})
ts
const result = await generateImage({
  adapter: openaiImage('dall-e-3'),
  prompt: 'A professional headshot photo',
  size: '1024x1024',
  modelOptions: {
    quality: 'hd',
    style: 'natural'
  }
})
const result = await generateImage({
  adapter: openaiImage('dall-e-3'),
  prompt: 'A professional headshot photo',
  size: '1024x1024',
  modelOptions: {
    quality: 'hd',
    style: 'natural'
  }
})