Skip to main content

Function: generateImage()

generateImage(opts): Promise<GenerateImageResult>

Defined in: packages/agentos/src/api/generateImage.ts:269

Generates one or more images using a provider-agnostic provider:model string.

Resolves credentials via resolveMediaProvider(), initialises the matching image provider, and returns a normalised GenerateImageResult.

Parameters​

opts​

GenerateImageOptions

Image generation options including model, prompt, and optional parameters.

Returns​

Promise<GenerateImageResult>

A promise resolving to the generation result with image data and metadata.

Example​

const result = await generateImage({
  provider: 'openai',
  model: 'dall-e-3',
  prompt: 'A photorealistic red panda sitting on a moonlit rooftop.',
  size: '1024x1024',
});
console.log(result.images[0].url);