FLflorafauna-ai
Canvas

Get a canvas action

Changed on

Describes one canvas action node: its declared inputs, outputs and parameter controls (for a custom action, parsed from its code), the parameter values stored on the node, and the nodes wired into it.

get/projects/{projectId}/actions/{nodeId}

Request

  • Base URL
    https://app.flora.ai/api/v1
  • URL
    https://app.flora.ai/api/v1/projects/{projectId}/actions/{nodeId}
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project identifier

Example:prj_abc123
nodeIdstring required

Canvas action node identifier: the persisted short id (n7) or the node UUID

Response

Canvas action.

project_idstring required

Project identifier

node_idstring required

Canvas action node UUID

short_idstring nullable required

Persisted short id (n7) of the node, when settled

action_id'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' nullable required

Action identifier

customboolean required

True when the node runs its own code rather than a prebuilt action

namestring required

Action name

descriptionstring required

Action description

language'javascript' | 'python' required

Action source language

runtime'node' | 'python' | 'browser' required

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

has_previewboolean 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

codestring nullable 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.

tool_stateunknown
charged_costnumber required

Cost per execution in USD

lockedboolean required

True when the node is locked and cannot be run or edited

param_valuesobject required

Parameter values stored on the node, keyed like params[].key; defaults apply for missing keys

canvas_urlstring uri required

Project canvas URL

Example response

{
  "project_id": "prj_abc123",
  "node_id": "4d2f7c7e-1b1a-4c7f-9e1d-5b9d1f3b2c10",
  "action_id": "color-grade-image-browser",
  "name": "Poster palette",
  "inputs": [
    {
      "name": "image"
    }
  ],
  "outputs": [
    {
      "name": "image"
    }
  ],
  "params": [
    {
      "key": "angle",
      "type": "select",
      "label": "Angle",
      "info_tooltip": "Rotation angle in degrees."
    }
  ],
  "connected_inputs": [
    {
      "node_id": "n3"
    }
  ]
}

Changes

  • a8351619f225Revision changes
    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

  • e54130373b10Revision changes
    • info

      endpoint added