Get an action

GET

/actions/{actionId}

import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

const action = await client.actions.retrieve({
  actionId: '<actionId>',
});
console.log(action);

Returns metadata and source for one released prebuilt Flora action. Action identifiers are raw slugs such as rotate-image, not action-prefixed IDs. A browser-runtime action with has_preview can be mounted live from its code.

Error responses use the standard error body.

Authorizations

bearerAuth

Parameters

Path Parameters

actionId

required

Action identifier

string

Allowed values: color-grade-image-browser overlay-image-browser draw-image-browser pixel-remover-image-browser magic-eraser-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

Action identifier

Responses

200

Action returned.

application/json

object

action_id

required

Action identifier

string

name

required

Action name

string

description

required

Action description

string

language

required

Action runtime language

string

Allowed values: javascript python

runtime

required

Where the action executes: a server sandbox (node, python) or the browser runtime (browser), which a host can also run live

string

Allowed values: node python browser

has_preview

required

True when the code is a browser-runtime module exporting preview, so a host can mount it live and re-render edits without a run

boolean

charged_cost

required

Cost per execution in USD

number

inputs

required

Action input slots

Array<object>

object

name

required

Action input or output name

string

type

required

Action input or output media type

string

Allowed values: image video text audio model3d

dynamic

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

boolean

optional

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

boolean

multiple

Any of:

unknown
object

outputs

required

Action output slots

Array<object>

object

name

required

Action input or output name

string

type

required

Action input or output media type

string

Allowed values: image video text audio model3d

dynamic

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

boolean

optional

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

boolean

multiple

Any of:

unknown
object

params

required

Action parameters

Array<object>

object

key

required

Action parameter key

string

type

required

Action parameter control type

string

label

Action parameter label

string

info_tooltip

Action parameter description

string

default_value

Default parameter value

available_values

Allowed parameter values

Array<object>

object

value

required

string

label

required

string

description

string

min_number_value

Lowest accepted number

number

max_number_value

Highest accepted number

number

number_step

Step between accepted numbers

number

placeholder

Placeholder shown in an empty text control

string

max_count

For colorList controls: how many colors the value may hold

integer

visible_if

Conditions under which a control is shown, all of which must hold. Keys are the snake_case keys of this same params list.

Array<object>

object

key

required

Key of the parameter this condition reads

string

equals

Any of:

string

not_equals

Any of:

string

point2d_min

Per-axis minimum for point2d values

object

Bound on the x axis

number

Bound on the y axis

number

Bound on the z axis (point3d only)

number

point2d_max

Per-axis maximum for point2d values

object

Bound on the x axis

number

Bound on the y axis

number

Bound on the z axis (point3d only)

number

point2d_step

Per-axis step for point2d values

object

Bound on the x axis

number

Bound on the y axis

number

Bound on the z axis (point3d only)

number

point3d_min

Per-axis minimum for point3d values

object

Bound on the x axis

number

Bound on the y axis

number

Bound on the z axis (point3d only)

number

point3d_max

Per-axis maximum for point3d values

object

Bound on the x axis

number

Bound on the y axis

number

Bound on the z axis (point3d only)

number

point3d_step

Per-axis step for point3d values

object

Bound on the x axis

number

Bound on the y axis

number

Bound on the z axis (point3d only)

number

code

required

The action’s source. For a browser-runtime action, mount it in the FLORA action runtime frame for a live preview; a run replays the same code on the server.

string

Example

{
  "action_id": "color-grade-image-browser",
  "name": "Rotate Image",
  "description": "Rotate an image by a fixed angle.",
  "language": "javascript",
  "runtime": "node",
  "inputs": [
    {
      "name": "image",
      "type": "image",
      "multiple": true
    }
  ],
  "outputs": [
    {
      "name": "image",
      "type": "image",
      "multiple": true
    }
  ],
  "params": [
    {
      "key": "angle",
      "type": "select",
      "label": "Angle",
      "info_tooltip": "Rotation angle in degrees."
    }
  ]
}