Skip to content
FLORA FLORA API
FLORA DocsGo to app
API Reference

Generations

Start a generation
client.generations.create(GenerationCreateParams { project_id, prompt, type, 4 more } body, RequestOptionsoptions?): GenerationCreateResponse { charged_cost, estimated_seconds, run_id, 6 more }
POST/generate
Get a run
client.generations.retrieve(stringrunID, RequestOptionsoptions?): GenerationRetrieveResponse { created_at, progress, run_id, 8 more }
GET/runs/{runId}
List generation history
client.generations.list(GenerationListParams { cursor, limit, project_id, 2 more } query?, RequestOptionsoptions?): GenerationsCursorPage<GenerationListResponse { created_at, generation_id, progress, 12 more } >
GET/generations
ModelsExpand Collapse
GenerationCreateResponse { charged_cost, estimated_seconds, run_id, 6 more }
charged_cost: number

Cost charged in USD

minimum0
estimated_seconds: number | null
minimum0
run_id: string

Run identifier

type: "generation" | "technique" | "action"

Run type

One of the following:
"generation"
"technique"
"action"
action?: Action | null
action_id: "color-grade-image-browser" | "overlay-image-browser" | "draw-image-browser" | 37 more

Action identifier

One of the following:
"color-grade-image-browser"
"overlay-image-browser"
"draw-image-browser"
"crop-image-browser"
"scene-3d-image-browser"
"blur-image-browser"
"change-image-ar-browser"
"rotate-image-browser"
"color-filter-image-browser"
"color-tint-image-browser"
"filter-color-image-browser"
"duplicate-image-browser"
"side-by-side-composite-browser"
"add-shape-to-image-browser"
"add-text-to-image-browser"
"qr-code-generator-browser"
"resize-image-browser"
"shader-effect-browser"
"split-text-browser"
"find-and-replace-text-browser"
"concat-text-browser"
"ken-burns-video"
"stitch-videos"
"split-video"
"extract-video-frames"
"color-grade-video"
"video-to-frame-grid"
"boomerang-video"
"reverse-video"
"video-to-long-exposure"
"video-effect"
"color-filter-video"
"speed-up-video"
"slow-down-video"
"duplicate-video"
"greenscreen-video"
"resize-video"
"change-video-ar"
"split-audio-from-video"
"merge-audio-into-video"
model?: Model | null
model_id: string

Model identifier

minLength1
poll_url?: string | null

URL to poll pending/running runs or fetch completed/failed run details.

formaturi
project_id?: string | null

Project identifier

technique?: Technique | null
name: string

Technique name

technique_id: string

Technique identifier

GenerationRetrieveResponse { created_at, progress, run_id, 8 more }
created_at: number
progress: number
run_id: string

Run identifier

status: "pending" | "running" | "completed" | "failed"
One of the following:
"pending"
"running"
"completed"
"failed"
charged_cost?: number

Cost charged in USD

minimum0
completed_at?: number
error_code?: string

Machine-readable run error code

error_message?: string

Human-readable run error message

outputs?: Array<Output>
output_id: string

Run output identifier

type: "imageUrl" | "videoUrl" | "audioUrl" | 2 more

Run output media type

One of the following:
"imageUrl"
"videoUrl"
"audioUrl"
"text"
"documentUrl"
url: string

Run output URL or text content

minLength1
poll_url?: string

URL to poll pending/running runs or fetch completed/failed run details.

formaturi
started_at?: number
GenerationListResponse { created_at, generation_id, progress, 12 more }
created_at: number
generation_id: string

Run identifier

progress: number
project_id: string

Project identifier

run_id: string

Run identifier

status: "pending" | "running" | "completed" | "failed"
One of the following:
"pending"
"running"
"completed"
"failed"
workspace_id: string

Workspace identifier

charged_cost?: number

Cost charged in USD

minimum0
completed_at?: number
error_code?: string

Machine-readable run error code

error_message?: string

Human-readable run error message

model?: Model { model_id }
model_id: string | null

Model identifier

minLength1
outputs?: Array<Output>
output_id: string

Run output identifier

type: "imageUrl" | "videoUrl" | "audioUrl" | 2 more

Run output media type

One of the following:
"imageUrl"
"videoUrl"
"audioUrl"
"text"
"documentUrl"
url: string

Run output URL or text content

minLength1
poll_url?: string

URL to poll pending/running runs or fetch completed/failed run details.

formaturi
started_at?: number