Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

generateImage.md

71 lines1.4 KB

1---
2id: generateImage
3title: generateImage
4---
5​
6# Function: generateImage()
7​
8```ts
9function generateImage<TAdapter>(options): ImageActivityResult;
10```
11​
12Defined in: [activities/generateImage/index.ts:134](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateImage/index.ts#L134)
13​
14Image activity - generates images from text prompts.
15​
16Uses AI image generation models to create images based on natural language descriptions.
17​
18## Type Parameters
19​
20### TAdapter
21​
22`TAdapter` *extends* [`ImageAdapter`](../interfaces/ImageAdapter.md)\<`string`, `object`, `any`, `any`\>
23​
24## Parameters
25​
26### options
27​
28`ImageActivityOptions`\<`TAdapter`\>
29​
30## Returns
31​
32`ImageActivityResult`
33​
34## Examples
35​
36```ts
37import { generateImage } from '@tanstack/ai'
38import { openaiImage } from '@tanstack/ai-openai'
39​
40const result = await generateImage({
41 adapter: openaiImage('dall-e-3'),
42 prompt: 'A serene mountain landscape at sunset'
43})
44​
45console.log(result.images[0].url)
46```
47​
48```ts
49const result = await generateImage({
50 adapter: openaiImage('dall-e-2'),
51 prompt: 'A cute robot mascot',
52 numberOfImages: 4,
53 size: '512x512'
54})
55​
56result.images.forEach((image, i) => {
57 console.log(`Image ${i + 1}: ${image.url}`)
58})
59```
60​
61```ts
62const result = await generateImage({
63 adapter: openaiImage('dall-e-3'),
64 prompt: 'A professional headshot photo',
65 size: '1024x1024',
66 modelOptions: {
67 quality: 'hd',
68 style: 'natural'
69 }
70})
71```