Create a generation

client.Generations.New(ctx, body) (*Generation, error)

POST/generations

Submit an image generation or edit job. Returns immediately with an opaque job ID to poll via GET /generations/{id}.

ParametersExpand Collapse

body GenerationNewParams

Prompt param.Field[string]

Text prompt

minLength1

maxLength6000

AspectRatio param.Field[GenerationNewParamsAspectRatio]optional

Output aspect ratio

const GenerationNewParamsAspectRatio3_1 GenerationNewParamsAspectRatio = "3:1"

const GenerationNewParamsAspectRatio2_1 GenerationNewParamsAspectRatio = "2:1"

const GenerationNewParamsAspectRatio16_9 GenerationNewParamsAspectRatio = "16:9"

const GenerationNewParamsAspectRatio3_2 GenerationNewParamsAspectRatio = "3:2"

const GenerationNewParamsAspectRatio1_1 GenerationNewParamsAspectRatio = "1:1"

const GenerationNewParamsAspectRatio2_3 GenerationNewParamsAspectRatio = "2:3"

const GenerationNewParamsAspectRatio9_16 GenerationNewParamsAspectRatio = "9:16"

const GenerationNewParamsAspectRatio1_2 GenerationNewParamsAspectRatio = "1:2"

const GenerationNewParamsAspectRatio1_3 GenerationNewParamsAspectRatio = "1:3"

ImageRef param.Field[[]GenerationNewParamsImageRef]optional

Reference images for style/content guidance. Up to 9 for type 'image', up to 8 for type 'image_edit'.

Data stringoptional

Base64-encoded image data

MediaType stringoptional

MIME type (e.g. image/jpeg). Required with data.

URL stringoptional

Publicly accessible image URL

Model param.Field[Model]optional

Model identifier. uni-1 is the default tier; uni-1-max produces higher-quality output than uni-1 at a higher per-image price. Both models are available to all accounts — see Pricing for per-image rates.

OutputFormat param.Field[GenerationNewParamsOutputFormat]optional

Output image format

const GenerationNewParamsOutputFormatPng GenerationNewParamsOutputFormat = "png"

const GenerationNewParamsOutputFormatJpeg GenerationNewParamsOutputFormat = "jpeg"

Source param.Field[GenerationNewParamsSource]optional

Reference image for guided generation. Provide either url or inline base64 data (not both).

Data stringoptional

Base64-encoded image data

MediaType stringoptional

MIME type (e.g. image/jpeg). Required with data.

URL stringoptional

Publicly accessible image URL

Style param.Field[GenerationNewParamsStyle]optional

Style preset (auto, manga)

const GenerationNewParamsStyleAuto GenerationNewParamsStyle = "auto"

const GenerationNewParamsStyleManga GenerationNewParamsStyle = "manga"

Type param.Field[GenerationNewParamsType]optional

The kind of generation to perform

const GenerationNewParamsTypeImage GenerationNewParamsType = "image"

const GenerationNewParamsTypeImageEdit GenerationNewParamsType = "image_edit"

UserID param.Field[string]optional

Your end-user's stable opaque identifier (no PII). Forwarded to upstream model providers as their per-user tagging field so trust & safety violations can be attributed to a specific end-user rather than the whole API account. Also used for per-end-user usage breakdowns in /v1/usage. Strongly recommended for partner integrations.

maxLength256

WebSearch param.Field[bool]optional

Enable web search grounding — the agent can search the web and download reference images before generating.

ReturnsExpand Collapse

type Generation struct{…}

Generation status and output

ID string

Generation identifier

formatuuid

CreatedAt string

Creation timestamp

Model Model

Model used

One of the following:

const ModelUni1 Model = "uni-1"

const ModelUni1Max Model = "uni-1-max"

State GenerationState

Current state of the generation

One of the following:

const GenerationStateQueued GenerationState = "queued"

const GenerationStateProcessing GenerationState = "processing"

const GenerationStateCompleted GenerationState = "completed"

const GenerationStateFailed GenerationState = "failed"

Type GenerationType

The kind of generation to perform

One of the following:

const GenerationTypeImage GenerationType = "image"

const GenerationTypeImageEdit GenerationType = "image_edit"

FailureCode GenerationFailureCodeoptional

Machine-readable failure code for programmatic handling

One of the following:

const GenerationFailureCodeContentModerated GenerationFailureCode = "content_moderated"

const GenerationFailureCodeGenerationFailed GenerationFailureCode = "generation_failed"

const GenerationFailureCodeBudgetExhausted GenerationFailureCode = "budget_exhausted"

const GenerationFailureCodeOutputNotFound GenerationFailureCode = "output_not_found"

const GenerationFailureCodeImageTooLarge GenerationFailureCode = "image_too_large"

const GenerationFailureCodeUnsupportedFormat GenerationFailureCode = "unsupported_format"

const GenerationFailureCodeCorruptInput GenerationFailureCode = "corrupt_input"

const GenerationFailureCodeInvalidRequest GenerationFailureCode = "invalid_request"

const GenerationFailureCodeRateLimited GenerationFailureCode = "rate_limited"

FailureReason stringoptional

Human-readable failure description

Output []GenerationOutputoptional

Generated outputs (populated on completion)

Type string

Media type (e.g. image)

URL string

Presigned URL (1hr expiry)

formaturi