Skip to content
Luma Agents
lumalabs.ai
API Reference
Generations

Create a generation

client.generations.create(GenerationCreateParams { prompt, aspect_ratio, image_ref, 7 more } body, RequestOptionsoptions?): Generation { id, created_at, model, 5 more }
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: GenerationCreateParams { prompt, aspect_ratio, image_ref, 7 more }
prompt: string

Text prompt

minLength1
maxLength6000
aspect_ratio?: "3:1" | "2:1" | "16:9" | 6 more | null

Output aspect ratio

One of the following:
"3:1"
"2:1"
"16:9"
"3:2"
"1:1"
"2:3"
"9:16"
"1:2"
"1:3"
image_ref?: Array<ImageRef>

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

data?: string | null

Base64-encoded image data

media_type?: string | null

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

url?: string | null

Publicly accessible image URL

model?: Model

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.

One of the following:
"uni-1"
"uni-1-max"
output_format?: "png" | "jpeg" | null

Output image format

One of the following:
"png"
"jpeg"
source?: Source | null

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

data?: string | null

Base64-encoded image data

media_type?: string | null

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

url?: string | null

Publicly accessible image URL

style?: "auto" | "manga"

Style preset (auto, manga)

One of the following:
"auto"
"manga"
type?: "image" | "image_edit"

The kind of generation to perform

One of the following:
"image"
"image_edit"
user_id?: string | null

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
ReturnsExpand Collapse
Generation { id, created_at, model, 5 more }

Generation status and output

id: string

Generation identifier

formatuuid
created_at: string

Creation timestamp

model: Model

Model used

One of the following:
"uni-1"
"uni-1-max"
state: "queued" | "processing" | "completed" | "failed"

Current state of the generation

One of the following:
"queued"
"processing"
"completed"
"failed"
type: "image" | "image_edit"

The kind of generation to perform

One of the following:
"image"
"image_edit"
failure_code?: GenerationFailureCode | null

Machine-readable failure code for programmatic handling

One of the following:
"content_moderated"
"generation_failed"
"budget_exhausted"
"output_not_found"
"image_too_large"
"unsupported_format"
"corrupt_input"
"invalid_request"
"rate_limited"
failure_reason?: string | null

Human-readable failure description

output?: Array<GenerationOutput { type, url } >

Generated outputs (populated on completion)

type: string

Media type (e.g. image)

url: string

Presigned URL (1hr expiry)

formaturi

Create a generation

import Luma from 'luma-agents';

const client = new Luma({
  authToken: process.env['LUMA_AGENTS_API_KEY'], // This is the default and can be omitted
});

const generation = await client.generations.create({
  prompt: 'A glass of iced coffee on a marble countertop, morning light streaming through a window',
});

console.log(generation.id);
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "created_at",
  "model": "uni-1",
  "state": "queued",
  "type": "image",
  "failure_code": "content_moderated",
  "failure_reason": "failure_reason",
  "output": [
    {
      "type": "type",
      "url": "https://example.com"
    }
  ]
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "created_at",
  "model": "uni-1",
  "state": "queued",
  "type": "image",
  "failure_code": "content_moderated",
  "failure_reason": "failure_reason",
  "output": [
    {
      "type": "type",
      "url": "https://example.com"
    }
  ]
}