ImageResult — Image Generation API Response Object

ImageResult is the value object returned after an image generation request completes. It exposes the first generated image directly through the output convenience property, the full set of generated images through images, and the standard token usage and provider metadata fields shared by all result types.

Properties

output

ImageData

required

The first generated image, provided as a convenience so single-image workflows do not need to index into the images array. This is always the same object as images[0].

Show ImageData properties and methods

base64

string | null

The Base64-encoded image data returned by the provider. null when the provider returned a URL instead of inline data.

mimeType

string

required

The MIME type of the image. Defaults to 'image/png' when the provider does not specify one.

width

int | null

The image width in pixels. null when the provider does not report dimensions.

height

int | null

The image height in pixels. null when the provider does not report dimensions.

url

string | null

A URL pointing to the generated image, when the provider returns a hosted URL instead of inline Base64 data. null when the image was returned as Base64.

bytes()

string | null

Decodes base64 into raw binary and returns it. Returns null when base64 is null or when strict Base64 decoding fails. Use this to feed image data directly into PHP image functions or HTTP responses.

save(string $path)

string

Decodes the Base64 image data and writes the raw bytes to the file at $path. Returns the $path that was written. Throws AiSdkException if the image contains no decodable binary content or if the write fails.

images

array<int, ImageData>

All images generated in this request. When only one image was requested, this array contains a single element that is identical to output.

usage

Usage

required

Token consumption statistics for this request.

Show Usage properties

inputTokens

int

required

Number of tokens in the prompt sent to the model. Defaults to 0.

outputTokens

int

required

Number of tokens in the model’s response. Defaults to 0.

totalTokens

int

required

Sum of inputTokens and outputTokens. Computed automatically when not provided by the provider.

reasoningTokens

int | null

Tokens consumed by extended reasoning, if reported by the provider. null when not applicable.

cachedInputTokens

int | null

Prompt tokens served from the provider’s prompt cache, when available. null otherwise.

rawResponse

array<string, mixed>

The unmodified response payload returned by the provider’s API. Useful for debugging or accessing provider-specific fields not surfaced in the structured properties above.

providerMetadata

array<string, mixed>

Provider-specific metadata keyed by provider name. Contents vary across providers and may include safety ratings, seed values, or model-specific annotations.

Code examples

Saving a single image

$result = $ai->image('A photorealistic red panda in a bamboo forest, golden hour.');

// Save directly using the convenience property
$result->output->save('/var/www/storage/red-panda.png');

// Or decode to bytes for streaming in an HTTP response
header('Content-Type: ' . $result->output->mimeType);
echo $result->output->bytes();

Iterating multiple images

$result = $ai->image('Abstract watercolour swirl', n: 4);

foreach ($result->images as $index => $image) {
    $path = "/var/www/storage/swatch-{$index}.png";
    $image->save($path);
    echo "Saved image {$index} to {$path}";

    // Inspect dimensions when the provider reports them
    if ($image->width !== null && $image->height !== null) {
        echo " ({$image->width}×{$image->height})";
    }

    echo "\n";
}

echo "Total images: " . count($result->images) . "\n";
echo "Input tokens used: " . $result->usage->inputTokens . "\n";

Using a URL-based result

$result = $ai->image('Minimalist vector logo for a tech startup.');

$image = $result->output;

if ($image->url !== null) {
    // Provider returned a hosted URL — use it directly
    echo "Image URL: {$image->url}\n";
} elseif ($image->base64 !== null) {
    // Provider returned inline Base64 data
    $image->save('/tmp/logo.png');
}

Core Classes

Results & Responses

Contracts & Enums

ImageResult — Image Generation API Response Object

Properties

Code examples

Saving a single image

Iterating multiple images

Using a URL-based result

Build docs developers (and LLMs) love

Core Classes

Results & Responses

Contracts & Enums

Documentation Index

​Properties

​Code examples

​Saving a single image

​Iterating multiple images

​Using a URL-based result

Build docs developers (and LLMs) love

Properties

Code examples

Saving a single image

Iterating multiple images

Using a URL-based result