Run a canvas action

POST

/projects/{projectId}/actions/{nodeId}/run

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

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

const action = await client.projects.actions.run({
  projectId: '<projectId>',
  nodeId: '<nodeId>',
});
console.log(action);

Runs an existing canvas action node through the action execution workflow.

Error responses use the standard error body.

Authorizations

• bearerAuth

Parameters

Path Parameters

projectId

required

Project identifier

string

/^prj_\S+$/

Project identifier

nodeId

required

Canvas action node identifier

string

>= 1 characters /^\S+$/

Canvas action node identifier

Responses

201

Canvas action run started.

Media type application/json

object

run_id

required

Run identifier

string

/^run_\S+$/

type

required

Run type

string

Allowed values: generation technique action

model

Any of:

object

object

model_id

required

Model identifier

string

>= 1 characters

null

null

technique

Any of:

object

object

technique_id

required

Technique identifier

string

/^tech_\S+$/

name

required

Technique name

string

null

null

action

Any of:

object

object

action_id

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

null

null

estimated_seconds

required

Any of:

integer

integer

null

null

charged_cost

required

Cost charged in USD

number

poll_url

Any of:

string

string format: uri

null

null

project_id

Any of:

string

Project identifier

string

/^prj_\S+$/

null

null

canvas_url

Any of:

string

string format: uri

null

null

warnings

Warnings for accepted input (unknown parameters and applied preprocessing changes)

Array<object>

object

code

required

Stable warning code

string

message

required

Human-readable warning message

string

field

Feature or parameter the warning relates to

string

Example

{
  "run_id": "run_abc123",
  "type": "generation",
  "model": {
    "model_id": "t2i-flux-2-pro"
  },
  "technique": {
    "technique_id": "tech_abcd1234"
  },
  "action": {
    "action_id": "color-grade-image-browser"
  },
  "project_id": "prj_abc123"
}