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

Actions

List actions
client.actions.list(RequestOptionsoptions?): ActionListResponse { actions }
GET/actions
Get an action
client.actions.retrieve("color-grade-image-browser" | "overlay-image-browser" | "draw-image-browser" | 37 moreactionID, RequestOptionsoptions?): ActionRetrieveResponse { action_id, charged_cost, description, 5 more }
GET/actions/{actionId}
Start an action run
client.actions.run(ActionRunParamsbody, RequestOptionsoptions?): ActionRunResponse { charged_cost, estimated_seconds, run_id, 6 more }
POST/runs/action
ModelsExpand Collapse
ActionListResponse { actions }
actions: Array<Action>
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"
charged_cost: number

Cost per execution in USD

minimum0
description: string

Action description

inputs: Array<Input>

Action input slots

name: string

Action input or output name

type: "image" | "video" | "text" | "audio"

Action input or output media type

One of the following:
"image"
"video"
"text"
"audio"
dynamic?: boolean

Deprecated alias for multiple: true. Mirrors multiple for back-compat.

multiple?: true | UnionMember1 { max, min }

Many-connections form. true is unbounded shorthand; the object form sets explicit min/max bounds.

One of the following:
true
true
UnionMember1 { max, min }
max?: number
minimum0
min?: number
minimum0
optional?: boolean

Whether the slot allows zero connections in single-input mode. Ignored when multiple is the object form (use min: 0 there instead).

language: "javascript" | "python"

Action runtime language

One of the following:
"javascript"
"python"
name: string

Action name

outputs: Array<Output>

Action output slots

name: string

Action input or output name

type: "image" | "video" | "text" | "audio"

Action input or output media type

One of the following:
"image"
"video"
"text"
"audio"
dynamic?: boolean

Deprecated alias for multiple: true. Mirrors multiple for back-compat.

multiple?: true | UnionMember1 { max, min }

Many-connections form. true is unbounded shorthand; the object form sets explicit min/max bounds.

One of the following:
true
true
UnionMember1 { max, min }
max?: number
minimum0
min?: number
minimum0
optional?: boolean

Whether the slot allows zero connections in single-input mode. Ignored when multiple is the object form (use min: 0 there instead).

params: Array<Param>

Action parameters

key: string

Action parameter key

type: string

Action parameter control type

available_values?: Array<AvailableValue>

Allowed parameter values

label: string
value: string
description?: string
default_value?: unknown

Default parameter value

info_tooltip?: string

Action parameter description

label?: string

Action parameter label

max_number_value?: number
min_number_value?: number
number_step?: number
ActionRetrieveResponse { action_id, charged_cost, description, 5 more }
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"
charged_cost: number

Cost per execution in USD

minimum0
description: string

Action description

inputs: Array<Input>

Action input slots

name: string

Action input or output name

type: "image" | "video" | "text" | "audio"

Action input or output media type

One of the following:
"image"
"video"
"text"
"audio"
dynamic?: boolean

Deprecated alias for multiple: true. Mirrors multiple for back-compat.

multiple?: true | UnionMember1 { max, min }

Many-connections form. true is unbounded shorthand; the object form sets explicit min/max bounds.

One of the following:
true
true
UnionMember1 { max, min }
max?: number
minimum0
min?: number
minimum0
optional?: boolean

Whether the slot allows zero connections in single-input mode. Ignored when multiple is the object form (use min: 0 there instead).

language: "javascript" | "python"

Action runtime language

One of the following:
"javascript"
"python"
name: string

Action name

outputs: Array<Output>

Action output slots

name: string

Action input or output name

type: "image" | "video" | "text" | "audio"

Action input or output media type

One of the following:
"image"
"video"
"text"
"audio"
dynamic?: boolean

Deprecated alias for multiple: true. Mirrors multiple for back-compat.

multiple?: true | UnionMember1 { max, min }

Many-connections form. true is unbounded shorthand; the object form sets explicit min/max bounds.

One of the following:
true
true
UnionMember1 { max, min }
max?: number
minimum0
min?: number
minimum0
optional?: boolean

Whether the slot allows zero connections in single-input mode. Ignored when multiple is the object form (use min: 0 there instead).

params: Array<Param>

Action parameters

key: string

Action parameter key

type: string

Action parameter control type

available_values?: Array<AvailableValue>

Allowed parameter values

label: string
value: string
description?: string
default_value?: unknown

Default parameter value

info_tooltip?: string

Action parameter description

label?: string

Action parameter label

max_number_value?: number
min_number_value?: number
number_step?: number
ActionRunResponse { 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