Skip to content
FLORA DocsGo to app

Generations

Start a generation
POST/generate
Get a run
GET/runs/{runId}
ModelsExpand Collapse
GenerationCreateResponse object { charged_cost, estimated_seconds, run_id, 6 more }
charged_cost: number

Cost charged in USD

minimum0
estimated_seconds: number
minimum0
run_id: string

Run identifier

type: "generation" or "technique" or "action"

Run type

One of the following:
"generation"
"technique"
"action"
action: optional object { action_id }
action_id: "split-text" or "find-and-replace-text" or "concat-text" or 34 more

Action identifier

One of the following:
"split-text"
"find-and-replace-text"
"concat-text"
"ken-burns-video"
"color-grade-image"
"change-image-ar"
"rotate-image"
"flip-image"
"color-filter-image"
"color-tint-image"
"filter-color-image"
"blur-image"
"duplicate-image"
"side-by-side-composite"
"add-shape-to-image"
"generate-shape-image"
"add-text-to-image"
"generate-text-image"
"qr-code-generator"
"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: optional object { model_id }
model_id: string

Model identifier

minLength1
poll_url: optional string

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

formaturi
project_id: optional string

Project identifier

technique: optional object { name, technique_id }
name: string

Technique name

technique_id: string

Technique identifier

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

Run identifier

status: "pending" or "running" or "completed" or "failed"
One of the following:
"pending"
"running"
"completed"
"failed"
charged_cost: optional number

Cost charged in USD

minimum0
completed_at: optional number
error_code: optional string

Machine-readable run error code

error_message: optional string

Human-readable run error message

outputs: optional array of object { output_id, type, url }
output_id: string

Run output identifier

type: "imageUrl" or "videoUrl" or "audioUrl" or 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: optional string

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

formaturi
started_at: optional number
GenerationListResponse object { 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" or "running" or "completed" or "failed"
One of the following:
"pending"
"running"
"completed"
"failed"
workspace_id: string

Workspace identifier

charged_cost: optional number

Cost charged in USD

minimum0
completed_at: optional number
error_code: optional string

Machine-readable run error code

error_message: optional string

Human-readable run error message

model: optional object { model_id }
model_id: string

Model identifier

minLength1
outputs: optional array of object { output_id, type, url }
output_id: string

Run output identifier

type: "imageUrl" or "videoUrl" or "audioUrl" or 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: optional string

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

formaturi
started_at: optional number